Skip to content

fix #1167: Added installation.rst to docs #1170

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.

Sign up for GitHub

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
merged 3 commits into from
Oct 11, 2022
Merged

fix #1167: Added installation.rst to docs #1170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3e9e1fe
Added installation.rst to docs
DON-BRAN Oct 11, 2022
1ad182b
Removed _installation_ section from index.rst
DON-BRAN Oct 11, 2022
e013e1a
Merge branch 'main' into add_installation_doc
DON-BRAN Oct 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 1 addition & 32 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,44 +25,13 @@ Zarr is still a young project. Feedback and bug reports are very welcome, please
the `GitHub issue tracker <https://github.com/zarr-developers/zarr-python/issues>`_. See
:doc:`contributing` for further information about contributing to Zarr.

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 you operating system and Python distribution. Other dependencies should be
installed automatically if using one of the installation methods below.

Install Zarr from PyPI::

$ pip install zarr

Alternatively, install Zarr via conda::

$ conda install -c conda-forge zarr

To install the latest development version of Zarr, you can use pip with the
latest GitHub main::

$ pip install git+https://github.com/zarr-developers/zarr-python.git

To work with Zarr source code in development, install from GitHub::

$ git clone --recursive https://github.com/zarr-developers/zarr-python.git
$ cd zarr-python
$ python setup.py install

To verify that Zarr has been fully installed, run the test suite::

$ pip install pytest
$ python -m pytest -v --pyargs zarr

Contents
--------

.. toctree::
:maxdepth: 2

installation
tutorial
api
spec
Expand Down
31 changes: 31 additions & 0 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
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 you operating system and Python distribution. Other dependencies should be
installed automatically if using one of the installation methods below.

Install Zarr from PyPI::

$ pip install zarr

Alternatively, install Zarr via conda::

$ conda install -c conda-forge zarr

To install the latest development version of Zarr, you can use pip with the
latest GitHub main::

$ pip install git+https://github.com/zarr-developers/zarr-python.git

To work with Zarr source code in development, install from GitHub::

$ git clone --recursive https://github.com/zarr-developers/zarr-python.git
$ cd zarr-python
$ python setup.py install

To verify that Zarr has been fully installed, run the test suite::

$ pip install pytest
$ python -m pytest -v --pyargs zarr