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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file insitupy_spatial-0.8.4.tar.gz.
File metadata
- Download URL: insitupy_spatial-0.8.4.tar.gz
- Upload date:
- Size: 467.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.0.1 CPython/3.10.12 Windows/10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db16688ebf714b31556509f48eeecbbb16df5d19dc288c33c915240fa37ff854
|
|
| MD5 |
b1cc9e0b08627c24404745f2651ae8d3
|
|
| BLAKE2b-256 |
77858f3102c152bffc1fe15c070ec538be2626b798dcf70deb9b301af8fead5c
|
File details
Details for the file insitupy_spatial-0.8.4-py3-none-any.whl.
File metadata
- Download URL: insitupy_spatial-0.8.4-py3-none-any.whl
- Upload date:
- Size: 496.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.0.1 CPython/3.10.12 Windows/10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
92669a815bf7e939ced111760840580ef80ab2bc448a654447d6e6c13e24c7c7
|
|
| MD5 |
6239d00c9aec9de74ef7c42320e28eaa
|
|
| BLAKE2b-256 |
a94ac5d20d2c1c64677138899a16fc48b20ce9343335872a63f8b9eef435330b
|