Metadata-Version: 2.4
Name: segtraq
Version: 0.0.3
Summary: SegTraQ - A Python toolkit for quantitative and visual quality control of segmentation and transcript assignment in spatial omics data.
Author-email: Daria Lazic <daria.lazic@embl.de>, Matthias Meyer-Bender <matthias.meyerbender@embl.de>, Martin Emons <martin.emons@uzh.ch>
Maintainer-email: Daria Lazic <daria.lazic@embl.de>, Matthias Meyer-Bender <matthias.meyerbender@embl.de>, Martin Emons <martin.emons@uzh.ch>
License: MIT
Project-URL: bugs, https://github.com/LazDaria/segtraq/issues
Project-URL: changelog, https://github.com/LazDaria/segtraq/blob/master/changelog.md
Project-URL: homepage, https://github.com/LazDaria/segtraq
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer
Requires-Dist: scanpy
Requires-Dist: spatialdata>=0.7.2
Requires-Dist: joblib
Requires-Dist: geopandas
Requires-Dist: igraph
Requires-Dist: rtree
Requires-Dist: rasterio
Requires-Dist: squidpy>=1.6.2
Requires-Dist: tqdm
Requires-Dist: anndata>=0.12
Requires-Dist: ovrlpy>=1.1.0
Requires-Dist: setuptools<82.0.0
Provides-Extra: test
Requires-Dist: coverage; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: ruff; extra == "test"
Requires-Dist: ty; extra == "test"
Requires-Dist: ipdb; extra == "test"
Requires-Dist: black[jupyter]; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-book-theme; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: pandoc; extra == "docs"
Requires-Dist: pygments; extra == "docs"
Requires-Dist: ipython; extra == "docs"
Dynamic: license-file

# SegTraQ

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

> ⚠️ Note: SegTraQ is under active development. 
> Features, interfaces, and functionality may change in upcoming releases. 
> SegTraQ currently supports imaging-based spatial transcriptomics data only. 
> Support for sequencing-based spatial transcriptomics is under development and will be included in a future release.
> To install the latest development version, run `pip install git+https://github.com/LazDaria/SegTraQ`.

SegTraQ (**Seg**mentation and **Tra**nscript Assignment **Q**uality Control) is a Python toolkit for quantitative and visual quality control of segmentation and transcript assignment in spatial omics data.

## Getting Started
Please refer to the [documentation](https://lazdaria.github.io/SegTraQ) for details on the API and tutorials.

## Installation

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

```
pip install segtraq
```

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

## System Requirements
### Hardware Requirements
`SegTraQ` requires only a standard computer with enough RAM to support the in-memory operations.

### Software Requirements
`SegTraQ` depends on the following packages:
```
scanpy
spatialdata
geopandas
igraph
rtree
rasterio
squidpy
anndata
ovrlpy
```
