Skip to main content

A Python package for automated cell type annotation in scRNA-seq using Azimuth Neural Network.

Project description

panhumanpy

Current version: 1.0.0 (Orion)

A package for unified and scalable organism-wide cell annotation in single-cell and spatial transcriptomics.

Uses the Pan-human Azimuth neural network.

Prerequisites

  • python >=3.9
  • pip
  • git

Installation

To install the base version of the package (with CPU support only), run:

pip install panhumanpy

or to install from GitHub, run:

pip install git+https://github.com/satijalab/panhumanpy.git

If you require GPU acceleration for enhanced performance on compatible hardware, install the package with GPU dependencies:

pip install panhumanpy[gpu]

or from GitHub:

pip install git+https://github.com/satijalab/panhumanpy.git#egg=panhumanpy[gpu]

Model Versions

panhumanpy uses versioned models corresponding to major package releases. The package defaults to model 'v{i}' where i is the major package version. For panhumanpy 1.0.0 (Orion), the default model version is 'v1'. For most users, the default version is recommended. The user can also choose to use a different model version as outlined in the tutorial mentioned below.

Currently available model versions: 'v0', 'v1'

Model Weights

Model weights are hosted on Zenodo and downloaded automatically on first use, cached in ~/.cache/panhumanpy/. No manual download is required.

Field Detail
DOI https://doi.org/10.5281/zenodo.20401417
Models v0, v1
License CC BY 4.0

Cell Ontology Mapping

panhumanpy includes a built-in crosswalk that maps Pan-human Azimuth cell type annotations to Cell Ontology (CL) terms. This mapping is versioned alongside the model and can be applied to annotation outputs via the map_to_cell_ontology function in ANNotate_tools or the map_to_cell_ontology method on AzimuthNN and AzimuthNN_base.

Crosswalk provenance:

Field Detail
Title Crosswalk of Pan-human Azimuth Types annotated cells to Cell Ontology
Author Aleix Puig-Barbe
Author ORCID 0000-0001-6677-8489
Reviewers Bruce Herr II, Katy Borner, Jie Zheng
Reviewer ORCIDs 0000-0002-6703-7647, 0000-0002-3321-6137, 0000-0002-2999-0103
Data DOI https://doi.org/10.48539/HBM727.TLKL.237
Date December 15, 2025
Version v1.1

Tutorial

For an introductory tutorial, please check out this notebook.

For more information on Pan-human Azimuth please visit our website.

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

panhumanpy-1.0.0.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

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

panhumanpy-1.0.0-py3-none-any.whl (229.5 kB view details)

Uploaded Python 3

File details

Details for the file panhumanpy-1.0.0.tar.gz.

File metadata

  • Download URL: panhumanpy-1.0.0.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for panhumanpy-1.0.0.tar.gz
Algorithm Hash digest
SHA256 3b1bd62090296e980519aeda93cf0f1c94a38e5ecf9292e94c5b91e1d8402d37
MD5 8d3f516bfa4ffbc2657bcc02823283f3
BLAKE2b-256 c1b6c04f039a96dea461c399570602ec7185d9080f97b32ac1704a99a5a1aa23

See more details on using hashes here.

File details

Details for the file panhumanpy-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: panhumanpy-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 229.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for panhumanpy-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1c5e033e5fc59ad11a88b2263ae168284481e48c854eec3543ac752a38f09098
MD5 59bb7f8309f4c3d6db09df1e321f8d76
BLAKE2b-256 8300987c04276be1c4d006b1f1748da3885f8b25b203e8c9f2e9ea115ab7e6ca

See more details on using hashes here.

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