vivarium-collective / vivarium-biosimulators

A Vivarium wrapper for BioSimulators
1 stars 0 forks source link

Add documentation for using licenses for commercial dependencies #11

Open jonrkarr opened 3 years ago

jonrkarr commented 3 years ago

CBMPy, COBRApy, MASSpy, and RBApy can run more quickly with commercial alternatives (e.g., Gurobi, CPLEX) to open-source dependencies (i.e. GLPK).

Where possible, we recommend Gurobi because its available for a wider range of Python versions, its easier to download and install, its easier to get licenses, and the licenses are easier to use with Docker images.

Gurobi can be used in Docker images with a Web License Service for Container Environments Only. We've set up COBRApy and RBApy to read license keys from environment variables that start with the prefix "GRB_". MASSpy could be set up similarly. For use with GitHub actions, license keys could be stored as secrets.

CPLEX can also be installed alongside our simulation tools. We don't include CPLEX in our Docker images due to the way that it is licensed, which prevents us from redistributing it.

jonrkarr commented 2 years ago

Since this is handled by BioSimulators, Vivarium users just need documentation about how to use this.

For Gurobi, users should either