Cell-BLAST


NameCell-BLAST JSON
Version 0.5.0 PyPI version JSON
download
home_page
SummarySingle-cell transcriptome querying tool
upload_time2023-02-08 02:59:57
maintainer
docs_urlNone
author
requires_python>=3.6
license
keywords bioinformatics deep-learning single-cell
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "Cell-BLAST",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "bioinformatics,deep-learning,single-cell",
    "author": "",
    "author_email": "Zhi-Jie Cao <caozj@mail.cbi.pku.edu.cn>, Runwei Lu <lurw2000@126.com>",
    "download_url": "https://files.pythonhosted.org/packages/a3/94/5c59fcc4d5501b06e732665339f1cd4be2741927aa6d739ab0f2bde6650f/Cell_BLAST-0.5.0.tar.gz",
    "platform": null,
    "description": "# Cell BLAST\n\n[![license-badge](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![pypi-badge](https://img.shields.io/pypi/v/Cell-BLAST)](https://pypi.org/project/Cell-BLAST)\n[![docs-badge](https://readthedocs.org/projects/cblast/badge/?version=latest)](https://cblast.readthedocs.io/en/latest/?badge=latest)\n[![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)\n\nCell BLAST is a cell querying tool for single-cell transcriptomics data.\n\nFor each query cell, it searches for most similar cells in the reference database.\nAnnotations in reference cells, e.g. cell type, can then be transfered to query\ncells based on cell-to-cell similarities. See our\n[publication](https://www.nature.com/articles/s41467-020-17281-7) for details.\n\n## Installing the Python package\n\nWe only support installation via pip right now.\n\nInstallation within virtual environments are recommended, see\n[virtualenv](https://virtualenv.pypa.io/en/latest/) or\n[conda](https://conda.io/docs/user-guide/tasks/manage-environments.html).\n\nFor conda, here's a one-liner to set up an empty environment\nfor installing Cell BLAST:\n\n`conda create -n cb python=3.9 && conda activate cb`\n\nThen follow the instructions below to install Cell BLAST:\n\n1. Install Cell BLAST from PyPI by running:\n\n   `pip install Cell-BLAST`\n\n   Or, install an editable dev version by running the following command\n   under the root directory of this repo:\n\n   `flit install -s`\n\n2. Check if the package can be imported in the Python interpreter:\n\n   ```python\n   import Cell_BLAST as cb\n   print(cb.__version__)\n   ```\n\n## Documentation\n\nOnline documentation can be found [here](https://cblast.readthedocs.org/).\n\n## Web-based interface\n\nWe also provide a [Web-based service](http://cblast.gao-lab.org/) for\noff-the-shelf querying of our ACA reference panels.\n\n## Reproduce results in the paper\n\nTo reproduce results, please check out the `rep` branch.\n\n## Contact\n\nFeel free to submit an issue or contact us at\n[cblast@mail.cbi.pku.edu.cn](mailto:cblast@mail.cbi.pku.edu.cn)\nfor problems about the Python package, website or database.\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Single-cell transcriptome querying tool",
    "version": "0.5.0",
    "split_keywords": [
        "bioinformatics",
        "deep-learning",
        "single-cell"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "755f805db541d9a31aaa40b51d82767a2fa532c3e5c4c3d3d4a72991cd38ef2b",
                "md5": "5373c29c08dd0fc481e8ea00a8055ab9",
                "sha256": "bae071911386d126258a6202289760bc61727cfac414757090b6dddd4520e08f"
            },
            "downloads": -1,
            "filename": "cell_blast-0.5.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5373c29c08dd0fc481e8ea00a8055ab9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 53016,
            "upload_time": "2023-02-08T02:59:56",
            "upload_time_iso_8601": "2023-02-08T02:59:56.124753Z",
            "url": "https://files.pythonhosted.org/packages/75/5f/805db541d9a31aaa40b51d82767a2fa532c3e5c4c3d3d4a72991cd38ef2b/cell_blast-0.5.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a3945c59fcc4d5501b06e732665339f1cd4be2741927aa6d739ab0f2bde6650f",
                "md5": "546bac8dd9d6ef8b19a97832182aeeb7",
                "sha256": "0d94630b9f5af2f607594602c832ebd39b77a8f0a950488e34a7e3427339dc4b"
            },
            "downloads": -1,
            "filename": "Cell_BLAST-0.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "546bac8dd9d6ef8b19a97832182aeeb7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 47839,
            "upload_time": "2023-02-08T02:59:57",
            "upload_time_iso_8601": "2023-02-08T02:59:57.718803Z",
            "url": "https://files.pythonhosted.org/packages/a3/94/5c59fcc4d5501b06e732665339f1cd4be2741927aa6d739ab0f2bde6650f/Cell_BLAST-0.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-08 02:59:57",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "cell-blast"
}
        
Elapsed time: 0.04284s