Skip to content
This repository was archived by the owner on Jan 5, 2026. It is now read-only.

README.md

Latest commit

 

History

History
61 lines (52 loc) · 2.12 KB

README.md

File metadata and controls

61 lines (52 loc) · 2.12 KB

version License: MIT python Build Status codecov black

Installation

To install it, make sure you have Python 3.6 or greater installed. Then run this command from the command prompt:

python setup.py install

or

pip install git+https://github.com/atomassi/mapping_distrinet

Supported solvers for the ILP approach

  • GLPK - open-source linear programming. It can be installed using brew: 
    brew install glpk
  • CBC - COIN-OR CBC: open-source linear programming. It can be installed using brew: 
    brew tap coin-or-tools/coinor
brew install cbc
  • Cplex - free for academic use
  • Gurobi - free for academic use
  • SCIP - free for noncommercial and academic institutes

Installed ILP solvers can be checked by running:

    pytest check_installed_solvers.py

Documentation

Documentation is based on Sphinx. In order to build it, follow the following steps:

pip install sphinx sphinx_rtd_theme
cd docs
make html # or make latex

Test

Tests are based on pytests which can be invoked by running

pytest