Interactive visualization of spatial omics data with napari
Project description
napari-spatialdata: interactive exploration and annotation of spatial omics data
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.
Installation
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+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.
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:
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for napari_spatialdata-0.5.0.post0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a9222fd5c0dc61f292547172c30a6a72aec0a52cdcdb90b36972962b773a4bb |
|
MD5 | a2928894188cba9373df3ff9daa709f6 |
|
BLAKE2b-256 | ec42c5bc112f842df3f83b6d74dea5bf638d4b3a98c5dfefcfd999e6321a34c5 |
Hashes for napari_spatialdata-0.5.0.post0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aef408edce2b39f365223b8e622d8a1a098f2f55365fea6599543cf9de02302a |
|
MD5 | a0476d46fd588a4089b4573f352bec16 |
|
BLAKE2b-256 | 8d824c0f00388408f95e30b8a781cccc6acecdc61d109c10e7a85c3782b461cd |