Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ChiamYu committed Oct 30, 2018
1 parent 10243a3 commit d1e5b24
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Expand Up @@ -4,7 +4,14 @@ Perform optStoic analysis using Python code that share the same data files with

Note: All the examples are specific for glycolysis pathway generation.

## Requirement:
## Install
```
git clone https://github.com/maranasgroup/optstoic-python.git
cd optstoic-python
python setup.py install
```

## Requirement
At least one of the following optimization solvers should be installed. To solve the loopless optStoic formulation, an optimization solver other than GLPK is recommended.

1. GLPK 4.47 installation
Expand Down Expand Up @@ -35,7 +42,7 @@ sudo make install INSTALLDIR="/usr/local/"

4. [CPLEX Optimizer](https://www.ibm.com/analytics/cplex-optimizer)

## Current project dependencies:
## Current project dependencies
1. [PuLP](https://github.com/coin-or/pulp). Run the [test](https://www.coin-or.org/PuLP/main/installing_pulp_at_home.html#testing-your-pulp-installation).
```
pip install pulp
Expand Down Expand Up @@ -84,6 +91,9 @@ from optstoicpy.test.testAll import test_all_optimization_scripts
test_all_optimization_scripts()
```

## Usage
Read the [tutorial](https://github.com/maranasgroup/optstoic-python/blob/master/optstoicpy/examples/methods.md).

## Development
To continue development with the code, please create a virtual environment and use `python setup.py develop` for installation.

Expand Down

0 comments on commit d1e5b24

Please sign in to comment.