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.
Choose the source that matches your workflow
PyPI package
Install the published Python bindings in a local virtual environment when you want the shortest path to importing localmip_py.
GitHub Releases
Use tagged archives and release notes when you need a stable source snapshot.
Repository
Clone or browse the main repository when you need the current development tree and full project history.
Three practical entry points
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)"
Build the CLI solver
From the repository root, the release build writes the binary and static library under build/.
./build.sh release
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.
What the current source tree provides
build/Local-MIPStandalone solver binary for file-based runs.
build/libLocalMIP.aStatic library with headers under src/.
localmip_pypybind11 bindings with result queries, parameter files, and modeling support.
example/C++ API demos for simple usage, model building, callbacks, and custom search components.
tests/CTest targets for unit, integration, and instance-driven checks.
test-set/Bundled sample .mps and .lp instances for demos and smoke tests.
Keep the environment explicit
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.
CMake 3.15+ and C++20
The source tree requires CMake 3.15 or later and a C++20-compatible GCC or Clang toolchain.
bash, make, POSIX utilities
The repository build scripts use standard shell tooling and write generated artifacts under build/.
Use the right snapshot for the right purpose
Releases and main repository
Use GitHub Releases for tagged source archives, or the repository for the current development tree.
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.
Check the install before moving on
Python import check
.venv/bin/python -c "import localmip_py as lm; print(lm.LocalMIP)"
Source build smoke test
Use the Quick Start for a verified 10-second CLI run on a bundled instance.
Open source, permissive, and inspectable
MIT License
Local-MIP is released under the MIT License.
Issues and documentation
Use GitHub Issues for bugs or feature requests, and the documentation pages for setup and examples.