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

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.


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:

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.2.5.post0.tar.gz (214.0 kB view details)

Uploaded Source

Built Distribution

spatialdata-0.2.5.post0-py3-none-any.whl (167.0 kB view details)

Uploaded Python 3

File details

Details for the file spatialdata-0.2.5.post0.tar.gz.

File metadata

  • Download URL: spatialdata-0.2.5.post0.tar.gz
  • Upload date:
  • Size: 214.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for spatialdata-0.2.5.post0.tar.gz
Algorithm Hash digest
SHA256 dc2b0c25b2bd2bdd41739c1b0c19f3e1c2215e13ab39c3b762a61b97e63f688c
MD5 1bed67323d42c13fbfa0a70a479457a7
BLAKE2b-256 63db603e79857a45253fd6f7df34ef5d5f92266a03f8393f113b852ff3877ea2

See more details on using hashes here.

File details

Details for the file spatialdata-0.2.5.post0-py3-none-any.whl.

File metadata

File hashes

Hashes for spatialdata-0.2.5.post0-py3-none-any.whl
Algorithm Hash digest
SHA256 61e7628a387261a8b8116bb28e9c76af438600855a74f168807fd1e834a6c5bd
MD5 7a31be3121bb866a3155f171f94f4bf7
BLAKE2b-256 f9a13f65aff044381794b455b6069a3ef0008f989707d96df9d7677eb9b8ebed

See more details on using hashes here.

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