Skip to content

Commit 850abd6

Browse files
authored
Update installation instructions on README
1 parent 459680a commit 850abd6

File tree

1 file changed

+31
-5
lines changed

1 file changed

+31
-5
lines changed

README.rst

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,23 +45,49 @@ and ``gzip`` modules from the stdlib (with some minor exceptions, see below).
4545

4646
Installation
4747
------------
48+
Recommended installation via conda
49+
..................................
50+
The recommended installation is an installation via Conda. For example using
51+
the `miniconda <https://docs.conda.io/en/latest/miniconda.html>`_ installer
52+
with a properly setup `conda-forge
53+
<https://conda-forge.org/docs/user/introduction.html#how-can-i-install-packages-from-conda-forge>`_
54+
channel. When used with bioinformatics tools setting up `bioconda
55+
<http://bioconda.github.io/user/install.html#install-conda>`_
56+
provides a clear set of installation instructions for conda.
57+
58+
python-isal is available on conda-forge and can be installed with
4859

49-
isa-l version 2.26.0 or higher is needed. This includes bindings for the
50-
adler32 function.
60+
.. code-block::
61+
62+
conda install python-isal
63+
64+
This will automatically install the isa-l library dependency as well, since
65+
it is available on conda-forge.
66+
67+
Installation with pip
68+
.....................
69+
isa-l version 2.26.0 or higher is needed on your system. This includes bindings
70+
for the adler32 function.
5171

5272
isa-l is available in numerous Linux distro's as well as on conda via the
5373
conda-forge channel. Checkout the `ports documentation
5474
<https://github.com/intel/isa-l/wiki/Ports--Repos>`_ on the isa-l project wiki
55-
to find out how to install it.
75+
to find out how to install it. It is important that the development headers
76+
are also installed.
77+
78+
On debian and ubuntu the isa-l libraries (including the development headers)
79+
can be installed with:
80+
81+
.. code-block::
82+
83+
sudo apt install libisal-dev
5684
5785
python-isal can be installed via pypi with:
5886

5987
.. code-block::
6088
6189
pip install isal
6290
63-
This requires the isa-l library to be installed on your pc.
64-
6591
The latest development version of python-isal can be installed with
6692

6793
.. code-block::

0 commit comments

Comments
 (0)