Skip to content

Commit

Permalink
Update install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
standage committed Jul 21, 2017
1 parent 2573e99 commit d22a934
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ kevlar/tests/data/simple-*.counttable
env2/
build/
kevlar/alignment.cpython-*.so
dist/
*.egg-info
16 changes: 12 additions & 4 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Otherwise, we suggest reading through the entire installation instructions befor
virtualenv kevlar-env
source kevlar-env/bin/activate # Execute this with every new terminal session
pip install git+https://github.com/dib-lab/khmer.git
pip install pysam networkx pandas git+https://github.com/dib-lab/khmer.git
pip install biokevlar
Virtual environment
Expand All @@ -21,18 +21,26 @@ We recommend installing **kevlar** and its dependencies in a dedicated `virtual
The command :code:`virtualenv kevlar-env` will create a new virtual environment, and only needs to be executed once.
The command :code:`source kevlar-env/bin/activate` will need to be re-executed any time you open a new session in your terminal.

.. note:: The label :code:`kevlar-env` can be replaced with an alternative label if desired.
.. note:: The label ``kevlar-env`` can be replaced with an alternative label if desired.

Dependencies
------------

The **kevlar** software has three non-standard dependencies: the `networkx package <https://networkx.github.io/>`_, the `pysam <http://pysam.readthedocs.io/>`_ package, and the `khmer package <http://khmer.readthedocs.io/>`_.
Currently, the **kevlar** installation procedure handles the first two dependencies automatically, but since it relies on an unreleased version of **khmer** this last dependency must be install manually.
The **kevlar** software has four non-standard dependencies: the `networkx <https://networkx.github.io/>`_ package, the `pysam <http://pysam.readthedocs.io/>`_ package, the `pandas <http://pandas.pydata.org/>`_ package, and the `khmer package <http://khmer.readthedocs.io/>`_.
The **kevlar** installation procedure *should* handle the first three dependencies automatically, but since it relies on an unreleased version of **khmer** this last dependency must be install manually.

.. code::
pip install git+https://github.com/dib-lab/khmer.git
.. note::

In some cases pip cannot install all dependencies automatically, and so manual installation is required.

.. code::
pip install pysam networkx pandas git+https://github.com/dib-lab/khmer.git
Installation
------------

Expand Down

0 comments on commit d22a934

Please sign in to comment.