Skip to content

Commit

Permalink
fix index
Browse files Browse the repository at this point in the history
  • Loading branch information
alimanfoo committed May 18, 2016
2 parents 8a4e0f8 + cfc64fc commit 38c62ad
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 17 deletions.
32 changes: 21 additions & 11 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,34 @@ Highlights
Status
------

Zarr is still in an early, experimental phase of development. Feedback and bug
Zarr is still in an early phase of development. Feedback and bug
reports are very welcome, please get in touch via the `GitHub issue
tracker <https://github.com/alimanfoo/zarr/issues>`_.

Installation
------------

Install from PyPI::
Zarr 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 Zarr from PyPI::

$ pip install zarr

Alternatively, install via conda::
Alternatively, install Zarr via conda::

$ conda install -c conda-forge zarr
Please note that Zarr includes a C extension providing integration
with the Blosc library. Installing via conda or installing on Windows
via pip 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 compiling from source is
preferable, as the Blosc library includes some optimisations for those
architectures::

Zarr includes a C extension providing integration with the Blosc_
library. Installing on any operating system via conda or installing on
Windows via pip 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
compiling from source is preferable as the Blosc library includes some
optimisations for AVX2::
$ pip install --no-binary=:all: zarr
To work with Zarr source code in development, install from GitHub::
Expand All @@ -51,7 +56,12 @@ To work with Zarr source code in development, install from GitHub::
$ cd zarr
$ python setup.py install

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

$ pip install nose zict heapdict
$ python -m nose -v zarr
Contents
--------

Expand Down
18 changes: 12 additions & 6 deletions docs/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,6 @@ dependency. Manual installation of NumPy prior to installing Zarr is
still recommended, however, as the automatic installation of NumPy may
fail or be sub-optimal on some platforms.

The :mod:`zarr.blosc` Cython extension is now optional and compilation
will only be attempted on posix systems; other systems will fall back
to a pure-Python installation (`#25
<https://github.com/alimanfoo/zarr/issues/25>`_). On these systems
only 'zlib', 'bz2' and 'lzma' compression will be available.

Some optimizations have been made within the :mod:`zarr.blosc`
extension to avoid unnecessary memory copies, giving a ~10-20%
performance improvement for multi-threaded compression operations.
Expand Down Expand Up @@ -99,6 +93,13 @@ A bug has been fixed within the ``__getitem__`` and ``__setitem__``
machinery for slicing arrays, to properly handle getting and setting
partial slices.

Acknowledgments
~~~~~~~~~~~~~~~

Thanks to Matthew Rocklin (mrocklin_), Stephan Hoyer (shoyer_),
Francesc Alted (FrancescAlted_), Anthony Scopatz (scopatz_) and Martin
Durant (martindurant_) for contributions and comments.

.. _release_0.4.0:

0.4.0
Expand All @@ -115,3 +116,8 @@ See `v0.4.0 release notes on GitHub
See `v0.3.0 release notes on GitHub
<https://github.com/alimanfoo/zarr/releases/tag/v0.3.0>`_.

.. _mrocklin: https://github.com/mrocklin
.. _shoyer: https://github.com/shoyer
.. _scopatz: https://github.com/scopatz
.. _martindurant: https://github.com/martindurant
.. _FrancescAlted: https://github.com/FrancescAlted
7 changes: 7 additions & 0 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,13 @@ because items within a Zip file cannot be updated in place. This means
that data in the array should only be written once and write
operations should be aligned with chunk boundaries.

The Dask project has implementations of the ``MutableMapping``
interface for distributed storage systems, see the `S3Map
<http://s3fs.readthedocs.io/en/latest/api.html#s3fs.mapping.S3Map>`_
and `HDFSMap
<https://github.com/dask/hdfs3/blob/master/hdfs3/mapping.py>`_
classes.

.. _tutorial_tips_chunks:

Chunk size and shape
Expand Down
1 change: 1 addition & 0 deletions requirements_test.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ coverage
flake8
heapdict
zict
twine

0 comments on commit 38c62ad

Please sign in to comment.