Metadata-Version: 2.1
Name: Cell_BLAST
Version: 0.5.0
Summary: Single-cell transcriptome querying tool
Keywords: bioinformatics,deep-learning,single-cell
Author-email: Zhi-Jie Cao <caozj@mail.cbi.pku.edu.cn>, Runwei Lu <lurw2000@126.com>
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Dist: numba>=0.39.0
Requires-Dist: scipy>=1.0.0
Requires-Dist: joblib>=0.12.0
Requires-Dist: scikit-learn>=0.17.0
Requires-Dist: tqdm>=4.12.0
Requires-Dist: pandas>=0.21.0
Requires-Dist: h5py>=2.7.0
Requires-Dist: python-igraph>=0.7.1
Requires-Dist: pronto>=0.10.2,<=0.12.2
Requires-Dist: seaborn>=0.9.0
Requires-Dist: umap-learn>=0.2.1
Requires-Dist: anndata>=0.6.14
Requires-Dist: loompy>=2.0.6
Requires-Dist: statsmodels>=0.8.0
Requires-Dist: plotly>=5.8.2
Requires-Dist: torch>=1.7.1
Requires-Dist: tensorboard>=2.9.1
Requires-Dist: scanpy>=1.9.0
Requires-Dist: leidenalg>=0.8.10
Requires-Dist: pynvml>=8.0.1
Requires-Dist: sphinx ; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints ; extra == "doc"
Requires-Dist: sphinx-copybutton ; extra == "doc"
Requires-Dist: nbsphinx ; extra == "doc"
Requires-Dist: sphinx-rtd-theme ; extra == "doc"
Requires-Dist: ipython ; extra == "doc"
Requires-Dist: jinja2 ; extra == "doc"
Requires-Dist: autodocsumm ; extra == "doc"
Project-URL: Github, https://github.com/gao-lab/Cell_BLAST-dev
Provides-Extra: doc

# Cell BLAST

[![license-badge](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![pypi-badge](https://img.shields.io/pypi/v/Cell-BLAST)](https://pypi.org/project/Cell-BLAST)
[![docs-badge](https://readthedocs.org/projects/cblast/badge/?version=latest)](https://cblast.readthedocs.io/en/latest/?badge=latest)
[![build-badge](https://github.com/gao-lab/Cell_BLAST/actions/workflows/build.yml/badge.svg)](https://github.com/gao-lab/Cell_BLAST/actions/workflows/build.yml)

Cell BLAST is a cell querying tool for single-cell transcriptomics data.

For each query cell, it searches for most similar cells in the reference database.
Annotations in reference cells, e.g. cell type, can then be transfered to query
cells based on cell-to-cell similarities. See our
[publication](https://www.nature.com/articles/s41467-020-17281-7) for details.

## Installing the Python package

We only support installation via pip right now.

Installation within virtual environments are recommended, see
[virtualenv](https://virtualenv.pypa.io/en/latest/) or
[conda](https://conda.io/docs/user-guide/tasks/manage-environments.html).

For conda, here's a one-liner to set up an empty environment
for installing Cell BLAST:

`conda create -n cb python=3.9 && conda activate cb`

Then follow the instructions below to install Cell BLAST:

1. Install Cell BLAST from PyPI by running:

   `pip install Cell-BLAST`

   Or, install an editable dev version by running the following command
   under the root directory of this repo:

   `flit install -s`

2. Check if the package can be imported in the Python interpreter:

   ```python
   import Cell_BLAST as cb
   print(cb.__version__)
   ```

## Documentation

Online documentation can be found [here](https://cblast.readthedocs.org/).

## Web-based interface

We also provide a [Web-based service](http://cblast.gao-lab.org/) for
off-the-shelf querying of our ACA reference panels.

## Reproduce results in the paper

To reproduce results, please check out the `rep` branch.

## Contact

Feel free to submit an issue or contact us at
[cblast@mail.cbi.pku.edu.cn](mailto:cblast@mail.cbi.pku.edu.cn)
for problems about the Python package, website or database.

