Skip to main content

Interactive visualization of spatial omics data with napari

Project description

SpatialData banner

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

License PyPI Python Version tests codecov status napari hub DOI

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.


You can install napari-spatialdata via pip:

pip install napari-spatialdata[extra]

The extra command will install the qt bindings PyQt5.

Note: if you have an M1/M2 Mac then you may get an error when installing PyQt5 via pip. A solution is to first install napari via conda (which will correctly install PyQt5), using

mamba install -c conda-forge napari pyqt

and then install napari-spatialdata via pip, but without the extra option:

pip install napari-spatialdata

You can find more details on this in the installation instructions.

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+

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

git clone
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.

Getting started

To learn how to use the napari-spatialdata plugin, please see the documentation. To learn how to integrate napari-spatialdata into your analysis workflows, please see the SpatialData tutorials. In particular:


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.


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


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


Marconato, L., Palla, G., Yamauchi, K.A. et al. SpatialData: an open and universal data framework for spatial omics. Nat Methods (2024).

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

napari-spatialdata-0.4.1.tar.gz (9.3 MB view hashes)

Uploaded Source

Built Distribution

napari_spatialdata-0.4.1-py3-none-any.whl (78.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page