Metadata-Version: 2.4
Name: spatialproteomics
Version: 0.8.1
Summary: Spatialproteomics is an interoperable toolbox for analyzing highly multiplexed fluorescence image data
Author: Matthias Meyer-Bender, Harald Vohringer
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cffi>=1.15.0
Requires-Dist: xarray>=2024.0.0
Requires-Dist: scikit-image>=0.25
Requires-Dist: matplotlib>=3.8.0
Requires-Dist: tqdm>=4.64.0
Requires-Dist: scikit-learn>=1.4.2
Requires-Dist: zarr
Requires-Dist: numpy>=1.23
Requires-Dist: opencv-python>=4.11.0
Requires-Dist: pyyaml>=6.0
Provides-Extra: docs
Requires-Dist: Sphinx>=7.0.0; extra == "docs"
Requires-Dist: sphinx-book-theme>=0.0.39; extra == "docs"
Requires-Dist: sphinxcontrib-napoleon==0.7; extra == "docs"
Requires-Dist: nbsphinx>=0.9; extra == "docs"
Requires-Dist: sphinx-multiversion>=0.2.4; extra == "docs"
Requires-Dist: IPython>=8.0.0; extra == "docs"
Provides-Extra: spatialdata
Requires-Dist: spatialdata>=0.4.0; extra == "spatialdata"
Provides-Extra: cellpose
Requires-Dist: cellpose>=3.1.0; extra == "cellpose"
Provides-Extra: stardist
Requires-Dist: stardist>=0.9.1; extra == "stardist"
Provides-Extra: anndata
Requires-Dist: anndata; extra == "anndata"
Provides-Extra: astir
Requires-Dist: astir>=0.1.5; extra == "astir"
Provides-Extra: dev
Requires-Dist: pytest>=7.1.2; extra == "dev"
Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
Requires-Dist: black[jupyter]>=22.6.0; extra == "dev"
Requires-Dist: isort>=5.10.1; extra == "dev"
Requires-Dist: flake8>=5.0.4; extra == "dev"
Requires-Dist: bandit>=1.7.4; extra == "dev"
Requires-Dist: safety>=2.1.1; extra == "dev"
Provides-Extra: all
Requires-Dist: spatialdata; extra == "all"
Requires-Dist: cellpose; extra == "all"
Requires-Dist: stardist; extra == "all"
Requires-Dist: astir; extra == "all"
Dynamic: license-file

# spatialproteomics

[![PyPI version](https://badge.fury.io/py/spatialproteomics.svg)](https://badge.fury.io/py/spatialproteomics)

`Spatialproteomics` is an interoperable toolbox for analyzing highly multiplexed fluorescence image data. This analysis involves a sequence of steps, including segmentation, image processing, marker quantification, cell type classification, and neighborhood analysis. 

<p align="center" width="100%">
    <img src="docs/_static/img/figure_1.png" alt="Spatialproteomics orchestrates analysis workflows for highly multiplexed fluorescence images." style="width:70%;">
</p>

## Principles

Multiplexed imaging data comprises at least 3 dimensions (i.e. `channels`, `x`, and `y`) and has often additional data such as segmentation masks or cell type annotations associated with it. In `spatialproteomics`, we use `xarray` to create a data structure that keeps all of these data dimension in sync. This data structure can then be used to apply all sorts of operations to the data. Users can segment cells, perform different image processing steps, quantify protein expression, predict cell types, and plot their data in various ways. By providing researchers with those tools, `spatialproteomics` can be used to quickly explore highly multiplexed spatial proteomics data directly within jupyter notebooks.

<p align="center" width="100%">
    <img src="docs/_static/img/supplementary_figure_1.png" alt="The spatialproteomics data structure enables synchronized subsetting across shared dimensions." style="width:70%;">
</p>

## Getting Started

Please refer to the [documentation](https://sagar87.github.io/spatialproteomics) for details on the API and tutorials.

## Installation

To install `spatialproteomics`, first create a python environment and install the package using 

```
pip install spatialproteomics
```

The installation of the package should take less than a minute.

## System Requirements
### Hardware Requirements
`spatialproteomics` requires only a standard computer with enough RAM to support the in-memory operations. Certain steps of the pipeline, such as segmentation, benefit from using a GPU.

### Software Requirements
The base version of `spatialproteomics` depends on the following packages:
```
xarray
zarr
numpy
scikit-image
scikit-learn
opencv-python
matplotlib
```

## Citation
Spatialproteomics - an interoperable toolbox for analyzing highly multiplexed fluorescence image data

Matthias Fabian Meyer-Bender, Harald Sager Voehringer, Christina Schniederjohann, Sarah Patricia Koziel, Erin Kim Chung, Ekaterina Popova, Alexander Brobeil, Lisa-Maria Held, Aamir Munir, Scverse Community, Sascha Dietrich, Peter-Martin Bruch, Wolfgang Huber

bioRxiv 2025.04.29.651202; doi: https://doi.org/10.1101/2025.04.29.651202
