Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
44 changes: 34 additions & 10 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
:::{tab-item} System

```shell
pip install "ngff-zarr[cli]"
pip install ngff-zarr
```

:::

:::{tab-item} Browser In Pyodide, e.g. the
[Pyodide REPL](https://pyodide.org/en/stable/console.html) or
[JupyterLite](https://jupyterlite.readthedocs.io/en/latest/try/lab),
:::{tab-item} Browser via Pyodide

With, for example, the [Pyodide REPL] or [JupyterLite]

```python
import micropip
Expand All @@ -23,14 +23,38 @@ await micropip.install('ngff-zarr')

::::

Optional dependencies include:
## Optional dependencies

Optional extras dependencies include:

`cli` : Additional IO libraries for
[file conversion programmically or via the command line interface (CLI)](./cli.md).

`dask-image` : Support multiscale generation with [dask-image]
[methods](./methods.md).

`itk` : Support multiscale generation with [itk] [methods](./methods.md).

`tensorstore` : Support writing with [tensorstore].

`cli` : Additional IO libraries for the command line interface (CLI).
`validate` : Support OME-Zarr data model metadata validation when reading.

`dask-image` : Multiscale generation with `dask-image` methods.
[Pyodide REPL]: https://pyodide.org/en/stable/console.html
[JupyterLite]: https://jupyterlite.readthedocs.io/en/latest/try/lab
[dask-image]: https://image.dask.org/en/latest/
[itk]: https://docs.itk.org/en/latest/learn/python_quick_start.html
[tensorstore]: https://google.github.io/tensorstore/

`itk` : Multiscale generation with `itk` methods.
### Install all optional dependencies

`tensorstore` : Support writing with `tensorstore`.
To install all optional dependencies:

`validate` : Support metadata validation when reading.
```shell
pip install "ngff-zarr[cli,dask-image,itk,tensorstore,validate]"
```

which is equivalent to:

```shell
pip install "ngff-zarr[all]"
```
1 change: 1 addition & 0 deletions docs/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,6 @@ import numpy as np

data = np.random.randint(0, 256, int(1e6)).reshape((1000, 1000))
multiscales = nz.to_multiscales(data)

nz.to_ngff_zarr('example.ome.zarr', multiscales)
```
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ validate = [
"jsonschema"
]
docs = [ "furo>=2024.7.18,<2025", "myst-parser>=3.0.1,<4", "sphinx>=7.4.7,<8", "sphinx-autodoc2>=0.5.0,<0.6", "sphinx-copybutton>=0.5.2,<0.6", "sphinx-design>=0.6.0,<0.7", "sphinxext-opengraph>=0.9.1,<0.10", "sphinx-autobuild>=2024.4.16,<2025"]
all = ["ngff-zarr[cli]", "ngff-zarr[docs]", "ngff-zarr[test]", "ngff-zarr[validate]", "ngff-zarr[tensorstore]"]


[tool.coverage.report]
Expand Down
Loading