diff --git a/.gitignore b/.gitignore index 8e5f52f..716c207 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,5 @@ kevlar/tests/data/simple-*.counttable env2/ build/ kevlar/alignment.cpython-*.so +dist/ +*.egg-info diff --git a/docs/install.rst b/docs/install.rst index 9198891..fb33d6c 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -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 @@ -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 `_, the `pysam `_ package, and the `khmer package `_. -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 `_ package, the `pysam `_ package, the `pandas `_ package, and the `khmer package `_. +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 ------------