Skip to content

Commit

Permalink
Mention that pip install will usually use a wheel
Browse files Browse the repository at this point in the history
...and that configuring via $HTSLIB_CONFIGURE_OPTIONS etc only applies
when installing from an sdist. Fixes #1086.
  • Loading branch information
jmarshall committed Sep 12, 2023
1 parent f386240 commit 315ac83
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,11 @@ The typical installation will be through pypi_::

pip install pysam

This will compile the ``builtin`` htslib source code within pysam.
Generally you will have the ``wheel`` package installed and
this command will speedily install pysam from a pre-built wheel.
Otherwise, or if you use pip's ``--no-binary`` option, this will
compile the ``builtin`` htslib source code within pysam and allow
the configuration facilities described below to be used.

htslib_ can be configured at compilation to turn on additional
features such support using encrypted configurations, enable plugins,
Expand Down

0 comments on commit 315ac83

Please sign in to comment.