Metadata-Version: 2.1
Name: Cellist
Version: 1.1.0
Summary: Cellist (Cell identification in high-resolution Spatial Transcriptomics) is a cell segmentation tool for high-resolution spatial transcriptomics. 
Home-page: https://github.com/dongqingsun96/Cellist
Author: Dongqing Sun
Author-email: Dongqing Sun <Dongqingsun96@gmail.com>
License: GPL-3.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy >=1.23.0
Requires-Dist: scikit-learn >=1.3.1
Requires-Dist: scikit-misc >=0.2.0
Requires-Dist: scikit-image >=0.20.0
Requires-Dist: pandas ==1.5.3
Requires-Dist: scipy >=1.9.1
Requires-Dist: matplotlib >=3.7.3
Requires-Dist: seaborn >=0.11.2
Requires-Dist: scanpy >=1.9.4
Requires-Dist: h5py >=3.8.0
Requires-Dist: tables >=3.7.0
Requires-Dist: spateo-release ==1.1.0
Requires-Dist: pyvista ==0.42
Requires-Dist: leidenalg ==0.10.2
Requires-Dist: cellpose ==3.1.1.1
Requires-Dist: sklearn-ann
Requires-Dist: annoy

# Cellist

![PyPI](https://img.shields.io/pypi/v/cellist)
![Downloads](https://pepy.tech/badge/cellist)
![Documentation Status](https://readthedocs.org/projects/cellist/badge/?version=latest)

Cell identification in high-resolution Spatial Transcriptomics

Cellist is a computational method to perform cell segmentation on high-resolution spatial transcriptomics (ST) data, including sequncing-based (e.g. Stereo-seq and Seq-Scope) and imaging-based (e.g. seqFISH+ and STARmap) technologies.

![avatar](docs/_static/img/Cellist_workflow.png)

## Change Log
### v0.0.1a
* Build Cellist.
### v1.0.0
* Release Cellist.
### v1.1.0
* Update Cellist model.
* Support Cellist for image-based segmentation.


## Install Cellist
```bash
git clone https://github.com/wanglabtongji/Cellist.git
cd Cellist
conda create -n Cellist python=3.10
pip install -r requirements.txt
pip install .
```

## Documentation
For full installation and usage of Cellist, please refer to the [documentation](https://cellist.readthedocs.io/en/latest/).

## Usage
```bash
cellist --help
usage: cellist [-h] [-v] {seg,align,watershed,cellpose,impute} ...

Cellist (Cell identification in high-resolution Spatial Transcriptomics) is a cell segmentation tool for high-
resolution spatial transcriptomics.

positional arguments:
  {seg,align,watershed,cellpose,impute}
    seg                 Run Cellist segmentation on high-resolution spatial transcriptomics.
    align               Refine alignment between image and spatial transcriptomics.
    watershed           Run initial watershed segmentation on the staining image.
    cellpose            Run initial cellpose segmentation on the staining image.
    impute              Perform spatially-aware gene imputation within each cluster.

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         Print version info.
```
