search

scverse / spatialdata-io

BSD 3-Clause "New" or "Revised" License
38 stars 25 forks source link

readme

SpatialData banner

spatialdata-io: convenient readers for loading common formats into SpatialData

Tests Documentation DOI

This package contains reader functions to load common spatial omics formats into SpatialData. Currently, we provide support for:

Note: all mentioned technologies are registered trademarks of their respective companies.

Getting started

Please refer to the documentation. In particular, the

Installation

You need to have Python 3.8 or newer installed on your system. If you don't have Python installed, we recommend installing Miniconda.

There are several alternative options to install spatialdata-io:

  1. Install the latest release of spatialdata-io from PyPI:
pip install spatialdata-io
  1. Install the latest development version:
pip install git+https://github.com/scverse/spatialdata-io.git@main

Contact

For questions and help requests, you can reach out in the scverse discourse. If you found a bug, please use the issue tracker.

Readers from third-party libraries

Technologies that can be read into SpatialData objects using third-party libraries:

Disclaimer

This library is community maintained and is not officially endorsed by the aforementioned spatial technology companies. As such, we cannot offer any warranty of the correctness of the representation. Furthermore, we cannot ensure the correctness of the readers for every data version as the technologies evolve and update their formats. If you find a bug or notice a misrepresentation of the data please report it via our Bug Tracking System so that it can be addressed either by the maintainers of this library or by the community.

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