.. toctree::
:maxdepth: 1
:hidden:
getting_started
about
user-guide/index
api/index
release
contributing
roadmap
Version: |version|
Download documentation: PDF/Zipped HTML
Useful links: Installation | Source Repository | Issue Tracker | Zulip Chat | Zarr specifications
Zarr is a file storage format for chunked, compressed, N-dimensional arrays based on an open-source specification.
.. grid:: 2
.. grid-item-card::
:img-top: _static/index_getting_started.svg
Getting Started
^^^^^^^^^^^^^^^
New to Zarr? Check out the getting started guide. It contains an
introduction to Zarr's main concepts and links to additional tutorials.
+++
.. button-ref:: getting_started
:expand:
:color: dark
:click-parent:
To the getting started guide
.. grid-item-card::
:img-top: _static/index_user_guide.svg
Guide
^^^^^
A detailed guide for how to use Zarr-Python.
+++
.. button-ref:: user-guide/index
:expand:
:color: dark
:click-parent:
To the user guide
.. grid-item-card::
:img-top: _static/index_api.svg
API Reference
^^^^^^^^^^^^^
The reference guide contains a detailed description of the functions,
modules, and objects included in Zarr. The reference describes how the
methods work and which parameters can be used. It assumes that you have an
understanding of the key concepts.
+++
.. button-ref:: api/index
:expand:
:color: dark
:click-parent:
To the api reference guide
.. grid-item-card::
:img-top: _static/index_contribute.svg
Contributor's Guide
^^^^^^^^^^^^^^^^^^^
Want to contribute to Zarr? We welcome contributions in the form of bug reports, bug fixes, documentation, enhancement proposals and more. The contributing guidelines will guide you through the process of improving Zarr.
+++
.. button-ref:: contributing
:expand:
:color: dark
:click-parent:
To the contributor's guide