From 3e9e1fe05251a445f4c0c586175616dc8ff4093b Mon Sep 17 00:00:00 2001 From: Awa Brandon Date: Tue, 11 Oct 2022 14:25:22 +0100 Subject: [PATCH 1/2] Added installation.rst to docs --- docs/index.rst | 1 + docs/installation.rst | 31 +++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 docs/installation.rst diff --git a/docs/index.rst b/docs/index.rst index f4afc9fd85..d63d460e2a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -63,6 +63,7 @@ Contents .. toctree:: :maxdepth: 2 + installation tutorial api spec diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000000..47c1dee269 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,31 @@ +Installation +============ + +Zarr depends on NumPy. It is generally best to `install NumPy +`_ 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 \ No newline at end of file From 1ad182b0d4251a7239276aca1029c7dbb74b8f89 Mon Sep 17 00:00:00 2001 From: Awa Brandon Date: Tue, 11 Oct 2022 14:42:08 +0100 Subject: [PATCH 2/2] Removed _installation_ section from index.rst --- docs/index.rst | 32 -------------------------------- 1 file changed, 32 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index d63d460e2a..007c8d010f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,38 +25,6 @@ Zarr is still a young project. Feedback and bug reports are very welcome, please the `GitHub issue tracker `_. See :doc:`contributing` for further information about contributing to Zarr. -Installation ------------- - -Zarr depends on NumPy. It is generally best to `install NumPy -`_ 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 --------