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[all]
The all
command will install the qt bindings PyQt5
.
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.2.post1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca7b6b80e9998616735e1f2ca75048c35d713b3abc50dbf237fde07ce25a2901 |
|
MD5 | c544607abe06205b6e4996e86b2ea007 |
|
BLAKE2b-256 | 34c57eaa1b346ad70eb9368a665c4ac0c259a61f1e3795b4cc6de0e17ac3027f |
Hashes for napari_spatialdata-0.5.2.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e22770ea8b40fee77f0d274eb18936ad9ba303a43eeea105270a5f1efea6266 |
|
MD5 | c1ca50de270118e2a9b3414e2743e8bf |
|
BLAKE2b-256 | 78a619c38c03c9749967fed382a337780c006f97329b86cb00bc7c04b44df09f |