Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Update index.rst for installation and test changes #426

Merged
merged 2 commits into from
Aug 3, 2023
Merged

Docs: Update index.rst for installation and test changes #426

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e13801c
Update index.rst for installation and test changes
psobolewskiPhD Apr 3, 2023
5de5818
Merge branch 'main' into bugfix/update_install_test_docs
psobolewskiPhD Jul 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,28 +28,35 @@ 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
for AVX2.
because you can compile the Blosc library from source with optimisations
for AVX2.::

$ pip install -v --no-cache-dir --no-binary numcodecs numcodecs

Note that if you compile the C extensions on a machine with AVX2 support
you probably then cannot use the same binaries on a machine without AVX2.
To disable compilation with AVX2 support regardless of the machine
architecture::

$ export DISABLE_NUMCODECS_AVX2=
$ pip install -v --no-cache-dir --no-binary numcodecs numcodecs
If you specifically want to disable AVX2 or SSE2 when compiling, you can use
the following environment variables::

To work with Numcodecs source code in development, install from GitHub::
$ export DISABLE_NUMCODECS_AVX2=1
$ export DISABLE_NUMCODECS_SSE2=1


To work with Numcodecs source code in development, clone the repository from GitHub
and then install in editable mode using `pip`.::

$ git clone --recursive https://github.com/zarr-developers/numcodecs.git
$ cd numcodecs
$ python setup.py install
$ pip install -e .[test,msgpack,zfpy]

Note: if you prefer to use the GitHub CLI ``gh`` you will need to append ``-- --recurse-submodules``
to the clone command to everything works properly.

To verify that Numcodecs has been fully installed (including the Blosc
extension) run the test suite::

$ pip install nose
$ python -m nose -v numcodecs
$ pytest -v

Contents
--------
Expand Down
Loading