aleable / mcopt

McOpt is an algorithm that can efficiently solve multicommodity routing problems on networks

---

McOpt /mæk ɒpt/ (Multicommodity Optimal Transport) is a Python implementation of the algorithms used in:

• [1] Alessandro Lonardi, Enrico Facca, Mario Putti and Caterina De Bacco. Designing optimal networks for multicommodity transport problem. Phys. Rev. Research 3, 043010 [arXiv].
• [2] Alessandro Lonardi, Mario Putti and Caterina De Bacco. Multicommodity routing optimization for engineering networks. Sci. Rep. 12, 7474 [arXiv].

This is a scheme capable of finding optimal multicommodity flows on networks solving a dynamical system of equations, or with a fixed-point scheme for the update of the flows. Our implementations is competitive with many state-of-the-art methods employed to solve optimal transport problems.

If you use this code please cite [1].

What's included

• code: contains the all the scripts necessary to run McOpt, and a Jupyter notebook (dashboard.ipynb) with which it is possible to easily interact with them and visualize the results
• data/input: contains the data needed to build the Paris metro network, where the algorithm can be tested. The network topology has been pre-processed and extracted using [3]. Passengers usage data have been taken from [4]
• misc: files used for the README.md
• setup.py: setup file to build the Python environment

[3] Rainer Kujala, Christoffer Weckström, Richard K. Darst, Miloš N. Mladenović and Jari Saramäki, Scientific data 5, 180089 (2018).
[4] “Trafic annuel entrant par station du réseau ferré 2019”, (2019), accessed: 2020-08-28.

How to use

To download this repository, copy and paste the following:

git clone https://github.com/aleable/McOpt

You are ready to test the code! But if you want to know how click HERE.

Contacts

For any issues or questions, feel free to contact us sending an email to [email protected].

License

Copyright (c) 2021 Alessandro Lonardi, Caterina De Bacco and Enrico Facca

_{Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:}

_{The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.}

_{THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.}