rust-or / rust-lp-modeler

Lp modeler written in Rust
MIT License
95 stars 29 forks source link

0.5 release #53

Closed EdorianDark closed 3 years ago

EdorianDark commented 4 years ago

What is missing for the 0.5 release?

carrascomj commented 4 years ago

Right now, NativeCbcSolver does not provide more functionality than any other backend, although that may (should) not be the case in the future. I hope it will get extended to account for things like https://github.com/jcavat/rust-lp-modeler/issues/45#issuecomment-632185150. For that reason, it currently has the same in-code documentation as the other solvers.

With that said, I believe that some documentation for the installation of coin-or cbc could be added like

# Debian
sudo apt install coinor-cbc
# Arch
sudo pacman -S coin-or
# Mac OS
brew tap coin-or-tools/coinor && brew install coin-or-tools/coinor/cbc

What are your thoughts on the documentation? Maybe adding a example?

jcavat commented 4 years ago

More time :-) Mainly I would like to

(the health situation in my contry has a big impact on my work right now)

jcavat commented 4 years ago

The documentation need to be improved. For simplicity we can add a repository in the examples folder with a specific README.md for NativeCbcSolver. If we wish to be more professional, we can imagine to generate a static doc with the possibility to run code directly on the navigator (such as https://doc.rust-lang.org/stable/rust-by-example/)

dlaehnemann commented 3 years ago

With that said, I believe that some documentation for the installation of coin-or cbc could be added like

# Debian
sudo apt install coinor-cbc
# Arch
sudo pacman -S coin-or
# Mac OS
brew tap coin-or-tools/coinor && brew install coin-or-tools/coinor/cbc

What are your thoughts on the documentation? Maybe adding a example?

For installation of solvers to use with lp-modeler, I have had good experience with using conda, which is a very easily installable package manager that does not need admin rights. The open source solvers that lp-modeler can interface with are available on conda-forge, the community channel:

And even Gurobi can be installed via conda (although with manual addition of a license afterwards):

Let me know if there is a PR to contribute respective text to.

jcavat commented 3 years ago

yes, you can propose a PR to update REAME.md file with this new documentation

dlaehnemann commented 3 years ago

I did, it's in PR #75. As this issue was originally about getting to release 0.5.0, I also included an update to the changelog with all the important changes I could identify from the commits.

jcavat commented 3 years ago

Many thanks!