gbd-mapping 5.0.5

A programmatically accessible mapping of gbd entities.

GBD Mapping

NOTE: This repository is archived and will receive no further updates.

The gbd_mapping package has been renamed and migrated into the vivarium-suite monorepo.

What changed

• PyPI distribution: gbd_mapping -> vivarium-gbd-mapping

• Import paths:

  • gbd_mapping -> vivarium.gbd_mapping

  • gbd_mapping_generator -> vivarium.gbd_mapping_generator

• Source: ihmeuw/gbd_mapping (archived) -> ihmeuw/vivarium-suite (under libs/gbd-mapping/)

• Docs: https://vivarium-gbd-mapping.readthedocs.io/

The final release on PyPI (v5.0.5) ships the same code as v5.0.4 with this banner added. v5.1.0 shipped a metapackage/shim that has since been yanked; the archived repo’s final release is v5.0.5. pip install gbd_mapping will keep resolving and importing as it did in v5.0.4, but the code is frozen and will not receive updates.

To migrate fully to the new package

Install:

pip install vivarium-gbd-mapping  # was: pip install gbd_mapping

Import:

from vivarium.gbd_mapping import causes, risk_factors  # was: from gbd_mapping import ...

Original package overview

Mapping of Global Burden of Disease (GBD) entities to their metadata.

There are two packages offered in this distribution. The first, the gbd_mapping_generator is a set of scripts that define templates and data gathering code used to produce the second, the gbd_mapping. The gbd_mapping_generator package will not function without access to the IHME cluster and some of our internally used data access libraries. Mapping updates are managed by an automated toolchain, so this shouldn’t be an issue.

The gbd_mapping is a programmatically accessible (and TAB-complete-able) set of mappings for GBD entities including:

• Causes

• Risks

• Covariates

• Etiologies

• Sequelae

You can install gbd_mapping from PyPI with pip:

> pip install gbd_mapping

or build it from source with

> git clone https://github.com/ihmeuw/gbd_mapping.git

> cd gbd_mapping

> pip install .

Development and Mapping Generation

In order to generate or regenerate the mappings from data, you must have access to the Institute for Health Metrics and Evaluation cluster and internal PyPI server. Contact <[e-mail]> if you need further instructions on that.

Given proper permissions, you can set up this library in development mode with

> git clone https://github.com/ihmeuw/gbd_mapping.git

> cd gbd_mapping

> pip install -e .['dev']

Check out the docs!