Skip to content

Commit

Permalink
Update docs regarding wheels (#250)
Browse files Browse the repository at this point in the history
* Update docs regarding wheels

* Use '--no-binary numcodecs'

Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>

Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>
  • Loading branch information
joshmoore and Czaki committed Sep 16, 2020
1 parent e73ea8b commit f872e45
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 10 deletions.
6 changes: 2 additions & 4 deletions docs/contributing.rst
Expand Up @@ -305,10 +305,8 @@ Tag the version (where "X.X.X" stands for the version number, e.g., "2.2.0")::
$ git tag -a v$version -m v$version
$ git push --tags

Release source code to PyPI::

$ python setup.py register sdist
$ twine upload dist/numcodecs-${version}.tar.gz
This will trigger a GitHub Action which will build the source
distribution as well as wheels for all major platforms.

Obtain checksum for release to conda-forge::

Expand Down
6 changes: 4 additions & 2 deletions docs/index.rst
Expand Up @@ -24,7 +24,9 @@ Alternatively, install via conda::
$ conda install -c conda-forge numcodecs

Numcodecs includes a C extension providing integration with the Blosc_
library. Installing via conda will install a pre-compiled binary distribution.
library. Wheels are available for most platforms.

Installing a wheel or via conda will install a pre-compiled binary distribution.
However, if you have a newer CPU that supports the AVX2 instruction set (e.g.,
Intel Haswell, Broadwell or Skylake) then installing via pip is preferable,
because this will compile the Blosc library from source with optimisations
Expand All @@ -36,7 +38,7 @@ To disable compilation with AVX2 support regardless of the machine
architecture::

$ export DISABLE_NUMCODECS_AVX2=
$ pip install -v --no-cache-dir numcodecs
$ pip install -v --no-cache-dir --no-binary numcodecs numcodecs

To work with Numcodecs source code in development, install from GitHub::

Expand Down
4 changes: 0 additions & 4 deletions release.txt

This file was deleted.

0 comments on commit f872e45

Please sign in to comment.