-
-
Notifications
You must be signed in to change notification settings - Fork 302
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Make code blocks console * Clean up installation page * Split into pip/conda * Fix doc headings * Fix contributing link * Fix contributing link
- Loading branch information
Showing
2 changed files
with
31 additions
and
20 deletions.
There are no files selected for viewing
This file contains 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,27 +1,37 @@ | ||
Installation | ||
============ | ||
|
||
Zarr depends on NumPy. It is generally best to `install NumPy | ||
<https://numpy.org/doc/stable/user/install.html>`_ first using whatever method is most | ||
appropriate for your operating system and Python distribution. Other dependencies should be | ||
installed automatically if using one of the installation methods below. | ||
pip | ||
--- | ||
|
||
Note: Zarr has endorsed `Scientific-Python SPEC 0 <https://scientific-python.org/specs/spec-0000/>`_ and now follows the version support window as outlined below: | ||
.. code-block:: console | ||
- Python: 36 months after initial release | ||
- Core package dependencies (e.g. NumPy): 24 months after initial release | ||
$ pip install zarr | ||
Install Zarr from PyPI:: | ||
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]"`` | ||
|
||
$ pip install zarr | ||
- ``gpu``: support for GPUs | ||
- ``fsspec``: support for reading/writing to remote data stores | ||
- ``tree``: support for pretty printing of directory trees | ||
|
||
Alternatively, install Zarr via conda:: | ||
conda | ||
----- | ||
|
||
.. code-block:: console | ||
$ conda install -c conda-forge zarr | ||
To install the latest development version of Zarr, you can use pip with the | ||
latest GitHub main:: | ||
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: | ||
|
||
$ pip install git+https://github.com/zarr-developers/zarr-python.git | ||
- Python: 36 months after initial release | ||
- Core package dependencies (e.g. NumPy): 24 months after initial release | ||
|
||
To work with Zarr source code in development, see `Contributing <contributing.html>`_. | ||
Development | ||
----------- | ||
To install the latest development version of Zarr, see `the contributing guide <contributing.html>`_. |
This file contains 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