Skip to content

Commit 3ef235e

Browse files
committed
Update documentation to reflect build changeS
1 parent 6c51d18 commit 3ef235e

File tree

1 file changed

+30
-26
lines changed

1 file changed

+30
-26
lines changed

README.rst

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -45,54 +45,58 @@ 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
48+
Installation with pip
49+
.....................
50+
Python-isal can be installed with:
5951

6052
.. code-block::
6153
62-
conda install python-isal
54+
pip install isal
6355
64-
This will automatically install the isa-l library dependency as well, since
65-
it is available on conda-forge.
56+
On linux this will install a wheel that has a statically linked version of
57+
isa-l (version 2.30.0) included.
6658

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.
59+
The latest development version of python-isal can be installed with
60+
61+
.. code-block::
62+
63+
pip install git+https://github.com/rhpvorderman/python-isal.git
64+
65+
Installing from source will dynamically link isa-l if already available
66+
on the system. This will speed up the installation process.
7167

7268
isa-l is available in numerous Linux distro's as well as on conda via the
7369
conda-forge channel. Checkout the `ports documentation
7470
<https://github.com/intel/isa-l/wiki/Ports--Repos>`_ on the isa-l project wiki
75-
to find out how to install it. It is important that the development headers
71+
to find out how to install it. It is important that the development headers
7672
are also installed.
7773

7874
On debian and ubuntu the isa-l libraries (including the development headers)
79-
can be installed with:
75+
can be installed with:
8076

8177
.. code-block::
8278
8379
sudo apt install libisal-dev
8480
85-
python-isal can be installed via pypi with:
81+
Installation via conda
82+
..................................
83+
Python-isal can be installed via conda, for example using
84+
the `miniconda <https://docs.conda.io/en/latest/miniconda.html>`_ installer
85+
with a properly setup `conda-forge
86+
<https://conda-forge.org/docs/user/introduction.html#how-can-i-install-packages-from-conda-forge>`_
87+
channel. When used with bioinformatics tools setting up `bioconda
88+
<http://bioconda.github.io/user/install.html#install-conda>`_
89+
provides a clear set of installation instructions for conda.
90+
91+
python-isal is available on conda-forge and can be installed with
8692

8793
.. code-block::
8894
89-
pip install isal
90-
91-
The latest development version of python-isal can be installed with
95+
conda install python-isal
9296
93-
.. code-block::
97+
This will automatically install the isa-l library dependency as well, since
98+
it is available on conda-forge.
9499

95-
pip install git+https://github.com/rhpvorderman/python-isal.git
96100

97101
Usage
98102
-----

0 commit comments

Comments
 (0)