cellxgene_census.get_source_h5ad_uri

cellxgene_census.get_source_h5ad_uri(dataset_id: str, *, census_version: str = 'stable') CensusLocator

Open the named version of the census, and return the URI for the dataset_id. This does not guarantee that the H5AD exists or is accessible to the user.

Parameters:
  • dataset_id – The dataset_id of interest.

  • census_version – The census version. Defaults to stable.

Returns:

A CensusLocator object that contains the URI and optional S3 region for the source H5AD.

Raises:

KeyError – if either dataset_id or census_version do not exist.

Lifecycle

maturing

Examples

>>> cellxgene_census.get_source_h5ad_uri("cb5efdb0-f91c-4cbd-9ad4-9d4fa41c572d")
{'uri': 's3://cellxgene-data-public/cell-census/2022-12-01/h5ads/cb5efdb0-f91c-4cbd-9ad4-9d4fa41c572d.h5ad',
's3_region': 'us-west-2'}