-
-
Notifications
You must be signed in to change notification settings - Fork 330
docs: update installation docs #2591
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
dcherian
merged 3 commits into
zarr-developers:docs/3.0-quickstart
from
jhamman:docs/3.0-installation
Jan 2, 2025
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
.. _dev-guide-contributing: | ||
|
||
Contributing | ||
============ | ||
|
||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,7 +14,6 @@ Zarr-Python | |
release | ||
contributing | ||
roadmap | ||
installation | ||
|
||
**Version**: |version| | ||
|
||
|
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
Installation | ||
============ | ||
|
||
Required dependencies | ||
--------------------- | ||
|
||
Required dependencies include: | ||
|
||
- `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) | ||
- `typing_extensions <https://typing-extensions.readthedocs.io>`_ (4.9 or later) | ||
- `donfig <https://donfig.readthedocs.io>`_ (0.8 or later) | ||
|
||
pip | ||
--- | ||
|
||
Zarr is available on `PyPI <https://pypi.org/project/zarr/>`_. Install it using ``pip``: | ||
|
||
.. code-block:: console | ||
|
||
$ pip install zarr | ||
|
||
There are a number of optional dependency groups you can install for extra functionality. | ||
These can be installed using ``pip install "zarr[<extra>]"``, e.g. ``pip install "zarr[gpu]"`` | ||
|
||
- ``gpu``: support for GPUs | ||
- ``remote``: support for reading/writing to remote data stores | ||
|
||
Additional optional dependencies include ``rich``, ``universal_pathlib``. These must be installed separately. | ||
|
||
conda | ||
----- | ||
|
||
Zarr is also published to `conda-forge <https://conda-forge.org>`_. Install it using ``conda``: | ||
|
||
.. code-block:: console | ||
|
||
$ conda install -c conda-forge zarr | ||
|
||
Conda does not support optional dependencies, so you will have to manually install any packages | ||
needed to enable extra functionality. | ||
|
||
Dependency support | ||
------------------ | ||
Zarr has endorsed `Scientific-Python SPEC 0 <https://scientific-python.org/specs/spec-0000/>`_ and now follows the version support window as outlined below: | ||
|
||
- Python: 36 months after initial release | ||
- Core package dependencies (e.g. NumPy): 24 months after initial release | ||
|
||
Development | ||
----------- | ||
To install the latest development version of Zarr, see the :ref:`contributing guide <dev-guide-contributing>`. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.