Metadata-Version: 2.1
Name: napari-spatialdata
Version: 0.5.3
Summary: Interactive visualization of spatial omics data with napari
Home-page: https://github.com/scverse/napari-spatialdata.git
Author: giovanni palla
Author-email: giov.pll@gmail.com
License: BSD-3-Clause
Project-URL: Bug Tracker, https://github.com/scverse/napari-spatialdata/issues
Project-URL: Documentation, https://spatialdata.scverse.org/projects/napari/en/latest/notebooks/spatialdata.html
Project-URL: Source Code, https://github.com/scverse/napari-spatialdata
Project-URL: User Support, https://github.com/scverse/napari-spatialdata/issues
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Framework :: napari
Classifier: Topic :: Software Development :: Testing
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.9.2
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: anndata
Requires-Dist: click
Requires-Dist: cycler
Requires-Dist: dask>=2024.4.1
Requires-Dist: geopandas
Requires-Dist: loguru
Requires-Dist: matplotlib
Requires-Dist: napari>=0.4.19.post1
Requires-Dist: napari-matplotlib
Requires-Dist: numba
Requires-Dist: numpy
Requires-Dist: packaging
Requires-Dist: pandas
Requires-Dist: pillow
Requires-Dist: qtpy
Requires-Dist: scanpy
Requires-Dist: scipy
Requires-Dist: shapely
Requires-Dist: scikit-learn
Requires-Dist: spatialdata>=0.2.1
Requires-Dist: superqt
Requires-Dist: typing-extensions>=4.8.0
Requires-Dist: vispy
Requires-Dist: xarray
Requires-Dist: xarray-datatree
Provides-Extra: all
Requires-Dist: napari[pyqt5]; extra == "all"
Provides-Extra: doc
Requires-Dist: sphinx>=4.5; extra == "doc"
Requires-Dist: sphinx-book-theme>=1.0.0; extra == "doc"
Requires-Dist: myst-parser; extra == "doc"
Requires-Dist: sphinxcontrib-bibtex>=1.0.0; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints>=1.11.0; extra == "doc"
Requires-Dist: sphinx-autobuild; extra == "doc"
Requires-Dist: scanpydoc; extra == "doc"
Requires-Dist: ipykernel; extra == "doc"
Requires-Dist: ipython; extra == "doc"
Requires-Dist: sphinx-copybutton; extra == "doc"
Requires-Dist: sphinx-qt-documentation; extra == "doc"
Requires-Dist: myst-nb; extra == "doc"
Requires-Dist: squidpy; extra == "doc"
Provides-Extra: pre
Requires-Dist: spatialdata>=0.1.0-pre0; extra == "pre"
Provides-Extra: readthedocs
Requires-Dist: pydantic<2; extra == "readthedocs"
Provides-Extra: test
Requires-Dist: loguru; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-qt; extra == "test"
Requires-Dist: pre-commit>=2.9.0; extra == "test"

![SpatialData banner](https://github.com/scverse/spatialdata/blob/main/docs/_static/img/spatialdata_horizontal.png?raw=true)

# napari-spatialdata: interactive exploration and annotation of spatial omics data

[![License](https://img.shields.io/pypi/l/napari-spatialdata.svg?color=green)](https://github.com/scverse/napari-spatialdata/raw/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/napari-spatialdata.svg?color=green)](https://pypi.org/project/napari-spatialdata)
[![Python Version](https://img.shields.io/pypi/pyversions/napari-spatialdata.svg?color=green)](https://python.org)
[![tests](https://github.com/scverse/napari-spatialdata/workflows/tests/badge.svg)](https://github.com/scverse/napari-spatialdata/actions)
[![codecov](https://codecov.io/gh/scverse/napari-spatialdata/branch/main/graph/badge.svg?token=ASqlOKnOj7)](https://codecov.io/gh/scverse/napari-spatialdata)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/scverse/napari-spatialdata/main.svg)](https://results.pre-commit.ci/latest/github/scverse/napari-spatialdata/main)
[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-spatialdata)](https://napari-hub.org/plugins/napari-spatialdata)
[![DOI](https://zenodo.org/badge/477021400.svg)](https://zenodo.org/badge/latestdoi/477021400)

This repository contains a napari plugin for interactively exploring and annotating SpatialData objects. `napari-spatialdata` is part of the `SpatialData` ecosystem. To learn more about SpatialData, please see the [documentation](https://spatialdata.scverse.org/).

## Installation

You can install `napari-spatialdata` via [pip]:

    pip install napari-spatialdata[all]

The `all` command will install the qt bindings `PyQt5`.

You can find more details on this in the [installation instructions](https://spatialdata.scverse.org/en/latest/installation.html).

## Using napari-spatialdata as default zarr reader

If you would like to use the plugin as the default zarr reader, in napari please go to `File` -> `Preferences`
-> `Plugins` and follow the instructions under `File extension readers`.

## Development Version

You can install `napari-spatialdata` from Github with:

    pip install git+https://github.com/scverse/napari-spatialdata

Or, you can also install in editable mode after cloning the repo by:

    git clone https://github.com/scverse/napari-spatialdata
    cd napari-spatialdata
    pip install -e .

Note: when performing an editable install of `napari-spatialdata`, `spatialdata` will be reinstalled from `pip`. So, if you previously also made an editable install of `spatialdata`, you need to re-run `pip install -e .` on the `spatialdata` repository. Please find more details on this in the [installation instructions](https://spatialdata.scverse.org/en/latest/installation.html).

## Getting started

To learn how to use the `napari-spatialdata` plugin, please see the [documentation](https://spatialdata.scverse.org/projects/napari/en/latest/notebooks/spatialdata.html). To learn how to integrate napari-spatialdata into your analysis workflows, please see the [SpatialData tutorials](https://spatialdata.scverse.org/en/latest/tutorials/notebooks/notebooks.html). In particular:

- [Annotating regions of interest with napari](https://spatialdata.scverse.org/en/latest/tutorials/notebooks/notebooks/examples/napari_rois.html)
- [Use landmark annotations to align multiple -omics layers](https://spatialdata.scverse.org/en/latest/tutorials/notebooks/notebooks/examples/alignment_using_landmarks.html)

## Contributing

Contributions are very welcome. Tests can be run with [tox], please ensure
the coverage at least stays the same before you submit a pull request.

## License

Distributed under the terms of the [BSD-3] license,
"napari-spatialdata" is free and open source software

## Issues

If you encounter any problems, please file an [issue] along with a detailed description.

## Citation

Marconato, L., Palla, G., Yamauchi, K.A. et al. SpatialData: an open and universal data framework for spatial omics. Nat Methods (2024). https://doi.org/10.1038/s41592-024-02212-x

[napari]: https://github.com/napari/napari
[cookiecutter]: https://github.com/audreyr/cookiecutter
[@napari]: https://github.com/napari
[mit]: http://opensource.org/licenses/MIT
[bsd-3]: http://opensource.org/licenses/BSD-3-Clause
[gnu gpl v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt
[gnu lgpl v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt
[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
[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin
[tox]: https://tox.readthedocs.io/en/latest/
[pip]: https://pypi.org/project/pip/
[pypi]: https://pypi.org/
[issue]: https://github.com/scverse/napari-spatialdata/issues
