Skip to main content

Package introducing the InSituPy framework to analyze single-cell spatial transcriptomics data.

Project description

InSituPy: A framework for histology-guided, multi-sample analysis of single-cell spatial transcriptomics data

InSituPy is a Python package designed to facilitate the analysis of single-cell spatial transcriptomics data. With InSituPy, you can easily load, visualize, and analyze the data, enabling and simplifying the comprehensive exploration of spatial gene expression patterns within tissue sections and across multiple samples. Currently the analysis is focused on data from the Xenium In Situ methodology but a broader range of reading functions will be implemented in the future.

Latest changes

!!!Warning: This repository is under very active development and it cannot be ruled out that changes might impair backwards compatibility. If you observe any such thing, please feel free to contact us to solve the problem. Thanks!

For the latest developments check out the releases.

Getting started

Documentation

For detailed instructions on using InSituPy, refer to the official documentation.

InSituPy works best within Jupyter Lab or Jupyter Notebook sessions. If you are not familiar with these platforms, see the documentation of Project Jupyter.

Installation

Create and activate a conda environment:

conda create --name insitupy python=3.10
conda activate insitupy

Install from PyPi:

pip install insitupy-spatial

Make sure you have Conda installed on your system before proceeding with these steps. If not, you can install Miniconda or Anaconda from https://docs.conda.io/en/latest/miniconda.html.

To ensure that the InSituPy package is available as a kernel in Jupyter notebooks within your conda environment, you can follow the instructions here.

For alternative installation strategies see the documentation.

Features

  • Data Preprocessing: InSituPy provides functions for normalizing, filtering, and transforming raw in situ transcriptomics data.
  • Interactive Visualization: Create interactive plots using napari to easily explore spatial gene expression patterns.
  • Annotation: Annotate Xenium In Situ data in the napari viewer or import annotations from external tools like QuPath.
  • Multi-sample analysis: Perform analysis on an experiment-level, i.e. with multiple samples at once.

Contributing

Contributions are welcome! If you find any issues or have suggestions for new features, please open an issue or submit a pull request.

Citation

If you use InSituPy in your work, please cite the preprint as follows:

InSituPy – A Framework for Histology-Guided, Multi-Sample Analysis of Single-Cell Spatial Transcriptomics Data.
Wirth, Johannes, Anna Chernysheva, Birthe Lemke, Isabel Giray, Aitana Egea Lavandera, and Katja Steiger.
bioRxiv, March 12, 2025. https://doi.org/10.1101/2025.03.07.641860.

License

InSituPy is licensed under the BSD-3-Clause.


InSituPy is developed and maintained by Johannes Wirth and Anna Chernysheva. Feedback is highly appreciated and hopefully InSituPy helps you with your analysis of spatial transcriptomics data. The package is thought to be a starting point to simplify the analysis of in situ sequencing data in Python and it would be exciting to integrate functionalities for larger and more comprehensive data structures. Currently, the framework focuses on the analysis of Xenium In Situ data but it is planned to integrate more methodologies and any support on this is highly welcomed.

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

insitupy_spatial-0.8.9.tar.gz (474.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

insitupy_spatial-0.8.9-py3-none-any.whl (501.5 kB view details)

Uploaded Python 3

File details

Details for the file insitupy_spatial-0.8.9.tar.gz.

File metadata

  • Download URL: insitupy_spatial-0.8.9.tar.gz
  • Upload date:
  • Size: 474.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.10.12 Windows/10

File hashes

Hashes for insitupy_spatial-0.8.9.tar.gz
Algorithm Hash digest
SHA256 50a4602de4487814cb71a1ef15fa3067ed64672f926055d392207110957fa0c9
MD5 4020faf7a869d0b2bbeee6f148585fa8
BLAKE2b-256 ee2244fb74c8f8ca51934a61ed6636387e14457071e749d48f6053894217e831

See more details on using hashes here.

File details

Details for the file insitupy_spatial-0.8.9-py3-none-any.whl.

File metadata

  • Download URL: insitupy_spatial-0.8.9-py3-none-any.whl
  • Upload date:
  • Size: 501.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.10.12 Windows/10

File hashes

Hashes for insitupy_spatial-0.8.9-py3-none-any.whl
Algorithm Hash digest
SHA256 7a059dea3c6156286ce8aa77d8f6830f1a9b908e2aa88ad3c7296fab9751cb8d
MD5 29c18ea7560ea3ff08b60ed7bc1168ba
BLAKE2b-256 bad512c25f3fbdc76de249b2c7f713cc01866ae0ac6f460ddd79d12a2873f3d8

See more details on using hashes here.

Supported by

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