Skip to main content

Cellarium Cell Annotation Service client tool

Project description

Cellarium Logo

Cellarium Cell Annotation Service (CAS) Client Library

This codebase contains the Python client library for using Cellarium Cell Annotation Service (CAS).

Installation

The cellarium-cas package officially supports Python versions between 3.7 and 3.12. We recommend using Python 3.10+. You can install CAS from PyPI using pip. To install the latest version, please run the following command:

$ pip install cellarium-cas

To install a specific version version_number, you can use the following command:

$ pip install cellarium-cas==<version_number>

If you wish to use visualization features, you can install the package with the visualization extras:

$ pip install cellarium-cas[vis]

Obtaining an API Token

You need an API token to use CAS. We are offerring a free public beta program for a limited time to try CAS and explore ways it can enhance your cell biology research. To obtain your unique API token to join the public beta program, please navigate to the CAS webpage at cellarium.ai, scroll to the bottom of the page, and sign up. We will contact you with your unique API key as soon as the public beta is available.

Quickstart Tutorial

The fastest way to get started with using CAS is to follow the quickstart tutorial: Click here to open the quickstart tutorial on GitHub

It is even easier to go through the quickstart tutorial on Google Colab. Remember, you still need an API key to successfully run through the tutorial: Click here to open the quickstart tutorial on Google Colab

Documentation

Please visit the project's ReadTheDocs page for additional documentation.

Citation

If the Cellarium Cell Annotation Service (CAS) contributes to your research, please cite our preprint to help others discover the project. You can reference it as follows:

Stephen R Williams, Fedor Grab, Govinda M Kamath, Yerdos Ordabayev, Jeff Mellen, Patrick Roelli, Kristian Cibulskis, Erik Lehnert, Fen Xie, Miguel Covarrubias, Nur-Taz Rahman, Timothy Tickle, Emre Erhan, Nicolas Malfroy-Camine, Kevin Lydon, Mehrtash Babadi, Nigel F. Delaney. 2025. Accelerating scRNA-seq Analysis: Automated cell type annotation using representation learning and vector search. bioRxiv. https://doi.org/10.1101/2025.10.06.680787

BibTeX users can cite CAS with:

@article{cellarium_10x_cas,
  author = {Williams, Stephen R. and Grab, Fedor and Kamath, Govinda M. and Ordabayev, Yerdos and Mellen, Jeff and Roelli, Patrick and Cibulskis, Kristian and Lehnert, Erik and Xie, Fen and Covarrubias, Miguel and Rahman, Nur-Taz and Tickle, Timothy and Erhan, Emre and Malfroy-Camine, Nicolas and Lydon, Kevin and Babadi, Mehrtash and Delaney, Nigel F.},
  title = {Accelerating scRNA-seq Analysis: Automated cell type annotation using representation learning and vector search},
  journal = {bioRxiv},
  year = {2025},
  doi = {10.1101/2025.10.06.680787},
  url = {https://www.biorxiv.org/content/10.1101/2025.10.06.680787v1}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cellarium_cas-1.8.0.tar.gz (165.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cellarium_cas-1.8.0-py3-none-any.whl (172.5 kB view details)

Uploaded Python 3

File details

Details for the file cellarium_cas-1.8.0.tar.gz.

File metadata

  • Download URL: cellarium_cas-1.8.0.tar.gz
  • Upload date:
  • Size: 165.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cellarium_cas-1.8.0.tar.gz
Algorithm Hash digest
SHA256 188b1a68fd844314992f116f747c0a6459e5239cc5fd427caddc197f7bacbb43
MD5 8ddb4c429fa316f51e1907fa303e1e5d
BLAKE2b-256 09af535feb6a3bd3d265fa978a0eb786f04ec68504c986e6a9e9e8d66001274f

See more details on using hashes here.

Provenance

The following attestation bundles were made for cellarium_cas-1.8.0.tar.gz:

Publisher: publish-pypi.yaml on cellarium-ai/cellarium-cas

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cellarium_cas-1.8.0-py3-none-any.whl.

File metadata

  • Download URL: cellarium_cas-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 172.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for cellarium_cas-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a0c0fd6c3353cbe65d44b4d6d24d32896e2014ca9f45a1d4b29818b80251fd34
MD5 26cd33df7fba478a6b9e77db40371b72
BLAKE2b-256 5a94235db8fa273c59d8c3a40704c5056a620ab1184d0767be496d59b4bb0e9b

See more details on using hashes here.

Provenance

The following attestation bundles were made for cellarium_cas-1.8.0-py3-none-any.whl:

Publisher: publish-pypi.yaml on cellarium-ai/cellarium-cas

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page