1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
.. numcodecs documentation main file, created by
sphinx-quickstart on Mon May 2 21:40:09 2016.
Numcodecs
=========
.. automodule:: numcodecs
Installation
------------
Numcodecs depends on NumPy. It is generally best to `install NumPy
<http://docs.scipy.org/doc/numpy/user/install.html>`_ first using
whatever method is most appropriate for you operating system and
Python distribution.
Install from PyPI::
$ pip install numcodecs
Alternatively, install via conda::
$ conda install -c conda-forge numcodecs
Numcodecs includes a C extension providing integration with the Blosc_
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.
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
To work with Numcodecs source code in development, install from GitHub::
$ git clone --recursive https://github.com/zarr-developers/numcodecs.git
$ cd numcodecs
$ python setup.py install
To verify that Numcodecs has been fully installed (including the Blosc
extension) run the test suite::
$ pip install nose
$ python -m nose -v numcodecs
Contents
--------
.. toctree::
:maxdepth: 2
abc
registry
blosc
lz4
zfpy
zstd
zlib
gzip
bz2
lzma
delta
fixedscaleoffset
quantize
bitround
packbits
categorize
checksum32
astype
json
pickles
msgpacks
vlen
shuffle
release
contributing
Acknowledgments
---------------
The following people have contributed to the development of NumCodecs by contributing code,
documentation, code reviews, comments and/or ideas:
* :user:`Francesc Alted <FrancescAlted>`
* :user:`Prakhar Goel <newt0311>`
* :user:`Jerome Kelleher <jeromekelleher>`
* :user:`John Kirkham <jakirkham>`
* :user:`Alistair Miles <alimanfoo>`
* :user:`Jeff Reback <jreback>`
* :user:`Trevor Manz <manzt>`
* :user:`Grzegorz Bokota <Czaki>`
* :user:`Josh Moore <joshmoore>`
* :user:`Martin Durant <martindurant>`
* :user:`Paul Branson <pbranson>`
Numcodecs bundles the `c-blosc <https://github.com/Blosc/c-blosc>`_ library.
Development of this package is supported by the
`MRC Centre for Genomics and Global Health <http://www.cggh.org>`_.
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _Blosc: http://www.blosc.org/
|
