Skip to content

Commit 3460242

Browse files
committed
tweak install instructions
1 parent 4fd1757 commit 3460242

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

docs/index.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,22 @@ Install Zarr from PyPI::
3131

3232
$ pip install zarr
3333

34-
Install Zarr from GitHub::
34+
Please note that Zarr includes a C extension providing integration
35+
with the Blosc library. Pre-compiled binaries are available for Linux
36+
and Windows platforms and will be installed automatically via pip if
37+
available. However, if you have a newer CPU that supports the AVX2
38+
instruction set (e.g., Intel Haswell, Broadwell or Skylake) then
39+
compiling from source is preferable, as the Blosc library includes
40+
some optimisations for those architectures::
41+
42+
$ pip install --no-binary=:all: zarr%
43+
44+
To work with Zarr source code in development, install from GitHub::
3545

3646
$ git clone --recursive https://github.com/alimanfoo/zarr.git
3747
$ cd zarr
3848
$ python setup.py install
3949

40-
N.B., on posix systems Zarr will attempt to build the Blosc C extension.
41-
Zarr will fall back to a pure Python installation on other platforms or if
42-
the C extension fails to build for any reason, which means that 'blosc'
43-
compression will not be available.
4450

4551
Contents
4652
--------

0 commit comments

Comments
 (0)