@@ -44,7 +44,60 @@ application (just like ``python -m gzip``). Full usage documentation can be
44
44
found below.
45
45
46
46
47
- .. include :: includes/Installation.rst
47
+ ============
48
+ Installation
49
+ ============
50
+ Installation with pip
51
+ ---------------------
52
+
53
+ ::
54
+
55
+ pip install isal
56
+
57
+ Installation is supported on Linux, MacOS and Windows. On most platforms
58
+ wheels are provided.
59
+ The installation will include a staticallly linked version of ISA-L.
60
+ If a wheel is not provided for your system the
61
+ installation will build ISA-L first in a temporary directory. Please check the
62
+ `ISA-L homepage <https://github.com/intel/isa-l >`_ for the build requirements.
63
+
64
+ The latest development version of python-isal can be installed with::
65
+
66
+ pip install git+https://github.com/rhpvorderman/python-isal.git
67
+
68
+ This requires having the build requirements installed.
69
+ If you wish to link
70
+ dynamically against a version of libisal installed on your system use::
71
+
72
+ PYTHON_ISAL_LINK_DYNAMIC=true pip install isal --no-binary isal
73
+
74
+ ISA-L is available in numerous Linux distro's as well as on conda via the
75
+ conda-forge channel. Checkout the `ports documentation
76
+ <https://github.com/intel/isa-l/wiki/Ports--Repos> `_ on the ISA-L project wiki
77
+ to find out how to install it. It is important that the development headers
78
+ are also installed.
79
+
80
+ On Debian and Ubuntu the ISA-L libraries (including the development headers)
81
+ can be installed with::
82
+
83
+ sudo apt install libisal-dev
84
+
85
+ Installation via conda
86
+ ----------------------
87
+ Python-isal can be installed via conda, for example using
88
+ the `miniconda <https://docs.conda.io/en/latest/miniconda.html >`_ installer
89
+ with a properly setup `conda-forge
90
+ <https://conda-forge.org/docs/user/introduction.html#how-can-i-install-packages-from-conda-forge> `_
91
+ channel. When used with bioinformatics tools setting up `bioconda
92
+ <http://bioconda.github.io/user/install.html#install-conda> `_
93
+ provides a clear set of installation instructions for conda.
94
+
95
+ python-isal is available on conda-forge and can be installed with::
96
+
97
+ conda install python-isal
98
+
99
+ This will automatically install the ISA-L library dependency as well, since
100
+ it is available on conda-forge.
48
101
49
102
======================================
50
103
Differences with zlib and gzip modules
0 commit comments