Skip to main content

Spatial data format.

Project description

SpatialData banner

SpatialData: an open and universal framework for processing spatial omics data.

Tests pre-commit.ci status codecov documentation badge DOI Downloads Release

SpatialData is a data framework that comprises a FAIR storage format and a collection of python libraries for performant access, alignment, and processing of uni- and multi-modal spatial omics datasets. This repository contains the core spatialdata library. See the links below to learn more about other packages in the SpatialData ecosystem.

spatialdata is part of the scverse® project (website, governance) and is fiscally sponsored by NumFOCUS. If you like scverse® and want to support our mission, please consider making a tax-deductible donation to help the project pay for developer time, professional services, travel, workshops, and a variety of other needs.

The spatialdata project also received support by the Chan Zuckerberg Initiative.


SpatialDataOverview

  • The library is currently under review. We expect there to be changes as the community provides feedback. We have an announcement channel for communicating these changes, please see the contact section below.
  • The SpatialData storage format is built on top of the OME-NGFF specification.

Getting started

Please refer to the documentation. In particular:

Another useful resource to get started is the source code of the spatialdata-io package, which shows example of how to read data from common technologies.

Installation

Check out the docs for more complete installation instructions. To get started with the "batteries included" installation, you can install via pip:

pip install "spatialdata[extra]"

or via conda: Update Feb 2025: spatialdata cannot be currently be installed via conda because some dependencies of our dependencies are not updated in conda-forge and we are still waiting for an update. Please install from pip; the latest versions of the spatialdata libraries are always available via PyPI.

mamba install -c conda-forge spatialdata napari-spatialdata spatialdata-io spatialdata-plot

Limitations

  • Code only manually tested for Windows machines. Currently the framework is being developed using Linux, macOS and Windows machines, but it is automatically tested only for Linux and macOS machines.

Contact

To get involved in the discussion, or if you need help to get started, you are welcome to use the following options.

Finally, especially relevant for for developers that are building a library upon spatialdata, please follow this channel for:

  • Announcements on new features and important changes Zulip.

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


Download files

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

Source Distribution

spatialdata-0.4.0.tar.gz (323.2 kB view details)

Uploaded Source

Built Distribution

spatialdata-0.4.0-py3-none-any.whl (183.6 kB view details)

Uploaded Python 3

File details

Details for the file spatialdata-0.4.0.tar.gz.

File metadata

  • Download URL: spatialdata-0.4.0.tar.gz
  • Upload date:
  • Size: 323.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for spatialdata-0.4.0.tar.gz
Algorithm Hash digest
SHA256 6c7d1abf366fd5e61e9c9b489d04ad644a9609489588fa3436e59f4c96b67846
MD5 7def42dc55d009cc7b7f9ee495ca3c3b
BLAKE2b-256 f997b841c596198152444ead8efc194444beac3031e2f9fb9fd0f2ca26d3c5f3

See more details on using hashes here.

File details

Details for the file spatialdata-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: spatialdata-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 183.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for spatialdata-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f0a3f76efda57a221a775686a4d376093bfea560492697f40820eb3ec6d6ea89
MD5 cae878366d0c5efcd5dfe3ac8eca41bd
BLAKE2b-256 1496015832d04de478b5ccf089fd259bff58adcff195cf27fec29b2bed307a46

See more details on using hashes here.

Supported by

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