Skip to content

Commit f93cebd

Browse files
Update index.rst for installation and test changes (#426)
1 parent 7cbf40d commit f93cebd

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

docs/index.rst

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,35 @@ library. Wheels are available for most platforms.
2828
Installing a wheel or via conda will install a pre-compiled binary distribution.
2929
However, if you have a newer CPU that supports the AVX2 instruction set (e.g.,
3030
Intel Haswell, Broadwell or Skylake) then installing via pip is preferable,
31-
because this will compile the Blosc library from source with optimisations
32-
for AVX2.
31+
because you can compile the Blosc library from source with optimisations
32+
for AVX2.::
33+
34+
$ pip install -v --no-cache-dir --no-binary numcodecs numcodecs
3335

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

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

42-
To work with Numcodecs source code in development, install from GitHub::
42+
$ export DISABLE_NUMCODECS_AVX2=1
43+
$ export DISABLE_NUMCODECS_SSE2=1
44+
45+
46+
To work with Numcodecs source code in development, clone the repository from GitHub
47+
and then install in editable mode using `pip`.::
4348

4449
$ git clone --recursive https://github.com/zarr-developers/numcodecs.git
4550
$ cd numcodecs
46-
$ python setup.py install
51+
$ pip install -e .[test,msgpack,zfpy]
52+
53+
Note: if you prefer to use the GitHub CLI ``gh`` you will need to append ``-- --recurse-submodules``
54+
to the clone command to everything works properly.
4755

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

51-
$ pip install nose
52-
$ python -m nose -v numcodecs
59+
$ pytest -v
5360

5461
Contents
5562
--------

0 commit comments

Comments
 (0)