Skip to content

Commit

Permalink
Merge branch 'doc-getting-start' of https://github.com/dstansby/zarr-…
Browse files Browse the repository at this point in the history
…python into doc/3.0-updates
  • Loading branch information
jhamman committed Dec 20, 2024
2 parents dcb2e39 + 8dbcf7c commit dd3805b
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 4 deletions.
22 changes: 22 additions & 0 deletions docs/about.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
About
=====

Zarr is a format for the storage of chunked, compressed, N-dimensional arrays
inspired by `HDF5 <https://www.hdfgroup.org/HDF5/>`_, `h5py
<https://www.h5py.org/>`_ and `bcolz <https://bcolz.readthedocs.io/>`_.

These documents describe the Zarr Python implementation. More information
about the Zarr format can be found on the `main website <https://zarr.dev>`_.

If you are using Zarr, we would `love to hear about it
<https://github.com/zarr-developers/community/issues/19>`_.

Funding
-------
The project is fiscally sponsored by `NumFOCUS <https://numfocus.org/>`_, a US
501(c)(3) public charity, and development is supported by the
`MRC Centre for Genomics and Global Health <https://www.cggh.org>`_
and the `Chan Zuckerberg Initiative <https://chanzuckerberg.com/>`_.


.. _NumCodecs: https://numcodecs.readthedocs.io/
5 changes: 2 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Zarr-Python
user-guide/index
api/index
developers/index
about

**Version**: |version|

Expand All @@ -27,7 +28,7 @@ Zarr is a storage format for chunked, compressed, N-dimensional arrays based on

* Create N-dimensional arrays with any NumPy dtype.
* Chunk arrays along any dimension.
* Compress and/or filter chunks using any Numcodecs_ codec.
* Compress and/or filter chunks using any NumCodecs_ codec.
* Store arrays in memory, on disk, inside a Zip file, on S3, ...
* Read an array concurrently from multiple threads or processes.
* Write to an array concurrently from multiple threads or processes.
Expand Down Expand Up @@ -112,5 +113,3 @@ Zarr-Python Documentation
:click-parent:

To the contributor's guide

.. _Numcodecs: https://numcodecs.readthedocs.io
2 changes: 1 addition & 1 deletion docs/user-guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Required dependencies

Required dependencies include:

- Python (3.11 or later)
- `Python <https://docs.python.org/3/>`_ (3.11 or later)
- `packaging <https://packaging.pypa.io>`_ (22.0 or later)
- `numpy <https://numpy.org>`_ (1.25 or later)
- `numcodecs[crc32c] <https://numcodecs.readthedocs.io>`_ (0.14 or later)
Expand Down

0 comments on commit dd3805b

Please sign in to comment.