Skip to main content

Spatial data format.

Project description

SpatialData banner

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

Tests status codecov documentation badge DOI Downloads

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.

The spatialdata project uses a consensus based governance model and is fiscally sponsored by NumFOCUS. 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.


  • 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.


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]"

Note: if you are using a Mac with an M1/M2 chip, please follow the installation instructions.


  • Windows support. Currently the framework is tested on Linux and macOS machines, not Windows machines. Users have reported bugs in read/write operations (27 March 2024).


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.


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

spatialdata-0.1.2.tar.gz (247.0 kB view hashes)

Uploaded Source

Built Distribution

spatialdata-0.1.2-py3-none-any.whl (143.9 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