diff --git a/docs/source/api.rst b/docs/source/api.rst index 34b9713a..0add3bad 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -1,8 +1,8 @@ -API -=== +Python API +========== .. toctree:: - :maxdepth: 3 + :maxdepth: 2 api/cli api/csv diff --git a/docs/source/cli.rst b/docs/source/cli.rst index 307121b8..6439a1a4 100644 --- a/docs/source/cli.rst +++ b/docs/source/cli.rst @@ -1,5 +1,5 @@ -Command-line Tool +Command-line tool ----------------- Open Zarr filesets containing images with associated OME metadata. diff --git a/docs/source/index.rst b/docs/source/index.rst index dfbe821f..a27693c4 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,18 +1,46 @@ -Welcome to ome-zarr-py documentation -==================================== +=========== +ome-zarr-py +=========== -**ome zarr** is a Python library for reading and writing multi-resolution images stored -as Zarr filesets, according to the `OME NGFF spec`_. +Tools for reading and writing multi-resolution images stored in Zarr filesets, according to the `OME NGFF spec`_. -Contents +Features -------- +- :doc:`cli` for reading and downloading OME-NGFF filesets. +- :doc:`api` for reading and writing OME-NGFF filesets (see :doc:`python` for example usage). +- Used by the `napari-ome-zarr`_ plugin for viewing OME-NGFF filesets in `napari`_. + +Contents +-------- .. toctree:: + :maxdepth: 1 - intro cli python api +Installation +------------ + +Install the latest release of `ome-zarr`_ from PyPI:: + + pip install ome-zarr + +or from conda-forge:: + + conda install -c conda-forge ome-zarr + + +License +------- + +Distributed under the terms of the `BSD`_ license, +"ome-zarr-py" is free and open source software + .. _`OME NGFF spec`: https://github.com/ome/ngff +.. _`BSD`: https://opensource.org/licenses/BSD-2-Clause +.. _`napari`: https://github.com/napari/napari +.. _`napari-ome-zarr`: https://github.com/ome/napari-ome-zarr +.. _`ome-zarr`: https://pypi.org/project/ome-zarr/ diff --git a/docs/source/intro.rst b/docs/source/intro.rst deleted file mode 100644 index e01dd884..00000000 --- a/docs/source/intro.rst +++ /dev/null @@ -1,47 +0,0 @@ -=========== -ome-zarr-py -=========== - -Tools for reading and writing multi-resolution images stored in Zarr filesets, according to the `OME NGFF spec`_. - - -Features --------- - -- :doc:`cli` for reading and downloading OME-NGFF filesets. -- :doc:`python` for reading and writing OME-NGFF filesets. -- `ome-zarr-py` is used by the `napari-ome-zarr`_ plugin for viewing OME-NGFF filesets in `napari`. - - -Installation ------------- - -Install the latest release of `ome-zarr`_ from PyPI:: - - pip install ome-zarr - -or from conda-forge:: - - conda install -c conda-forge ome-zarr - -Installation for developers:: - - git clone git@github.com:ome/ome-zarr-py.git - cd ome-zarr-py - pip install -e . - - -License -------- - -Distributed under the terms of the `BSD`_ license, -"ome-zarr-py" is free and open source software - -.. _`OME NGFF spec`: https://github.com/ome/ngff -.. _`@napari`: https://github.com/napari -.. _`BSD`: https://opensource.org/licenses/BSD-2-Clause -.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0 -.. _`Mozilla Public License 2.0`: https://www.mozilla.org/media/MPL/2.0/index.txt -.. _`napari`: https://github.com/napari/napari -.. _`napari-ome-zarr`: https://github.com/ome/napari-ome-zarr -.. _`ome-zarr`: https://pypi.org/project/ome-zarr/ diff --git a/docs/source/python.rst b/docs/source/python.rst index 80591861..82f8c4a0 100644 --- a/docs/source/python.rst +++ b/docs/source/python.rst @@ -1,5 +1,5 @@ -ome_zarr Python library -======================= +Python tutorial +=============== Writing OME-NGFF images -----------------------