Skip to content

Commit

Permalink
update install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
cdanielmachado committed Sep 17, 2020
1 parent 5869aa0 commit 88d1ee7
Showing 1 changed file with 7 additions and 20 deletions.
27 changes: 7 additions & 20 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,41 +4,28 @@
Installation
============

**CarveMe** currently supports Python 2.7 and Python 3.6, which are available for all major operating systems. We recommend the `Anaconda python
**CarveMe** currently supports Python 3.6 and 3.7.
We recommend using the `Anaconda python
distribution <https://www.continuum.io/downloads>`_.

It can be easily installed using the **pip** package manager:
CarveMe can be easily installed using the **pip** package manager:

.. code-block:: console
$ pip install carveme
This will automatically install other dependencies as well:

- framed_
- pandas_

.. _framed: https://github.com/cdanielmachado/framed
.. _pandas: https://pandas.pydata.org/

Additionally, you must manually install two external dependencies:

- diamond_
- diamond_ (conda install -c bioconda diamond)
- IBM CPLEX_ Optimizer

.. _diamond: https://github.com/bbuchfink/diamond
.. _CPLEX: https://www-01.ibm.com/software/commerce/optimization/cplex-optimizer/
.. _CPLEX: https://www.ibm.com/analytics/cplex-optimizer

Note that you will need to register with IBM to obtain an academic license for CPLEX.
Note that you will need to register with IBM to obtain an `academic license for CPLEX <https://www.ibm.com/academic/home>`_.

Also, after installing CPLEX, do not forget to install the CPLEX python API (see the CPLEX documentation_ for details).
**IMPORTANT:** After installing CPLEX, do not forget to install the CPLEX python API (see the CPLEX documentation_ for details).

.. _documentation: https://www.ibm.com/support/knowledgecenter/SSSA5P_12.7.1/ilog.odms.cplex.help/CPLEX/GettingStarted/topics/set_up/Python_setup.html

After installation you should run the initialization script to update the internal data files:

.. code-block:: console
$ carveme_init
Everything should be ready now! See the next section for instructions on how to start *carving*.

0 comments on commit 88d1ee7

Please sign in to comment.