Metadata-Version: 2.1
Name: spatialproteomics
Version: 0.6.0
Summary: spatialproteomics provides tools for the analysis of highly multiplexed immunofluorescence data
Author: Harald Vohringer
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Provides-Extra: docs
Requires-Dist: Sphinx (==5.0.0) ; extra == "docs"
Requires-Dist: matplotlib (>=3.5.3,<4.0.0)
Requires-Dist: nbsphinx (==0.8.9) ; extra == "docs"
Requires-Dist: numpy (<2.0.0)
Requires-Dist: scikit-image (>=0.19.3)
Requires-Dist: scikit-learn (>=1.2.2,<2.0.0)
Requires-Dist: sphinx-rtd-theme (==1.0.0) ; extra == "docs"
Requires-Dist: sphinxcontrib-napoleon (==0.7) ; extra == "docs"
Requires-Dist: tqdm (>=4.64.0)
Requires-Dist: xarray (>=2023.0.0,<2024.0.0)
Requires-Dist: zarr (>=2.14.2,<3.0.0)
Description-Content-Type: text/markdown

# spatialproteomics

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

`spatialproteomics` is a light weight wrapper around `xarray` with the intention to facilitate the processing, exploration and analysis of highly multiplexed immunohistochemistry data.

<p align="center" width="100%">
    <img width="100%" src="docs/preview2.png">
</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.


## Installation

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

```
pip install spatialproteomics
```

## Documentation

Check the documentation for further information https://sagar87.github.io/spatialproteomics/.

For a more interactive learning experience, you can also check out [this workshop](https://github.com/MeyerBender/spatialproteomics_workshop) on spatialproteomics (based on v0.5.7, some syntax details might have changed since).

