From d4b9c8c0f75d55b9f61f32b7bd97d57d0f541efa Mon Sep 17 00:00:00 2001 From: LucaMarconato <2664412+LucaMarconato@users.noreply.github.com> Date: Sat, 4 Jan 2025 22:10:47 +0100 Subject: [PATCH] Update README.md with: solutions to common problems --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 2eaa490c..f3dd6fca 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,18 @@ Technologies that can be read into `SpatialData` objects using third-party libra 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](https://github.com/scverse/spatialdata-io/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen) so that it can be addressed either by the maintainers of this library or by the community. +## Solutions to common problems +### Problem: I cannot visualize the data, everything is slow +Solution: after parsing the data with `spatialdata-io` readers, you need to write it to Zarr and read it again. Otherwise the performance advantage given by the SpatialData Zarr format will not available. +```python +from spatialdata_io import xenium +from spatialdata import read_zarr + +sdata = xenium('raw_data') +sdata.write('data.zarr') +sdata = read_zarr('sdata.zarr') +``` + ## 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