Software

Get Local-MIP

Use the published Python bindings through a local virtual environment, or download the source tree when you need the CLI solver, C++ API, examples, callbacks, or reproducible archived versions.

Release Channels

Choose the source that matches your workflow

Python

PyPI package

Install the published Python bindings in a local virtual environment when you want the shortest path to importing localmip_py.

Tagged source

GitHub Releases

Use tagged archives and release notes when you need a stable source snapshot.

Development

Repository

Clone or browse the main repository when you need the current development tree and full project history.

Install Paths

Three practical entry points

01

Install Python bindings

For Linux x86_64, create a local virtual environment, install from PyPI, and import the module with the same interpreter.

python3 -m venv .venv && .venv/bin/python -m pip install localmip
.venv/bin/python -c "import localmip_py as lm; print(lm.LocalMIP)"
02

Build the CLI solver

From the repository root, the release build writes the binary and static library under build/.

./build.sh release
03

Build everything

Use the full build when you also need examples and the local pybind11 module.

./build.sh all

For runnable first commands and a 10-second smoke test, use the Quick Start.

Distribution Contents

What the current source tree provides

CLIbuild/Local-MIP

Standalone solver binary for file-based runs.

C++build/libLocalMIP.a

Static library with headers under src/.

Pythonlocalmip_py

pybind11 bindings with result queries, parameter files, and modeling support.

Examplesexample/

C++ API demos for simple usage, model building, callbacks, and custom search components.

Teststests/

CTest targets for unit, integration, and instance-driven checks.

Datatest-set/

Bundled sample .mps and .lp instances for demos and smoke tests.

Requirements

Keep the environment explicit

PyPI path

Python 3.8+ on Linux x86_64

The package metadata requires Python 3.8+ and is documented for Linux x86_64. On Debian/Ubuntu, use a virtual environment rather than installing into the system Python.

Source builds

CMake 3.15+ and C++20

The source tree requires CMake 3.15 or later and a C++20-compatible GCC or Clang toolchain.

Build tools

bash, make, POSIX utilities

The repository build scripts use standard shell tooling and write generated artifacts under build/.

Version Notes

Use the right snapshot for the right purpose

Software snapshots

Releases and main repository

Use GitHub Releases for tagged source archives, or the repository for the current development tree.

Paper reproduction

Local-MIP 1.0 archive

The experimental results reported in the CP 2024 and Artificial Intelligence 2025 papers were obtained using Local-MIP 1.0.

Verification

Check the install before moving on

Python import check

.venv/bin/python -c "import localmip_py as lm; print(lm.LocalMIP)"
License & Help

Open source, permissive, and inspectable

License

MIT License

Local-MIP is released under the MIT License.

Support

Issues and documentation

Use GitHub Issues for bugs or feature requests, and the documentation pages for setup and examples.