Skip to content

Commit dd3805b

Browse files
committed
Merge branch 'doc-getting-start' of https://github.com/dstansby/zarr-python into doc/3.0-updates
2 parents dcb2e39 + 8dbcf7c commit dd3805b

File tree

3 files changed

+25
-4
lines changed

3 files changed

+25
-4
lines changed

docs/about.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
About
2+
=====
3+
4+
Zarr is a format for the storage of chunked, compressed, N-dimensional arrays
5+
inspired by `HDF5 <https://www.hdfgroup.org/HDF5/>`_, `h5py
6+
<https://www.h5py.org/>`_ and `bcolz <https://bcolz.readthedocs.io/>`_.
7+
8+
These documents describe the Zarr Python implementation. More information
9+
about the Zarr format can be found on the `main website <https://zarr.dev>`_.
10+
11+
If you are using Zarr, we would `love to hear about it
12+
<https://github.com/zarr-developers/community/issues/19>`_.
13+
14+
Funding
15+
-------
16+
The project is fiscally sponsored by `NumFOCUS <https://numfocus.org/>`_, a US
17+
501(c)(3) public charity, and development is supported by the
18+
`MRC Centre for Genomics and Global Health <https://www.cggh.org>`_
19+
and the `Chan Zuckerberg Initiative <https://chanzuckerberg.com/>`_.
20+
21+
22+
.. _NumCodecs: https://numcodecs.readthedocs.io/

docs/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Zarr-Python
1212
user-guide/index
1313
api/index
1414
developers/index
15+
about
1516

1617
**Version**: |version|
1718

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

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

114115
To the contributor's guide
115-
116-
.. _Numcodecs: https://numcodecs.readthedocs.io

docs/user-guide/installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Required dependencies
66

77
Required dependencies include:
88

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

0 commit comments

Comments
 (0)