Metadata-Version: 2.4
Name: vivarium-gbd-mapping
Version: 7.0.0
Summary: A programmatically accessible mapping of GBD entities.
Author-email: The vivarium developers <vivarium.dev@gmail.com>
License: BSD 3-Clause
Project-URL: Homepage, https://github.com/ihmeuw/vivarium-suite
Project-URL: Source, https://github.com/ihmeuw/vivarium-suite/tree/main/libs/gbd-mapping
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: vivarium-build-utils<5.0.0,>=4.0.0
Provides-Extra: test
Requires-Dist: vivarium-dependencies[pytest]; extra == "test"
Requires-Dist: pytest-vivarium; extra == "test"
Provides-Extra: docs
Requires-Dist: vivarium-dependencies[sphinx]; extra == "docs"
Provides-Extra: interactive
Requires-Dist: vivarium-dependencies[interactive]; extra == "interactive"
Provides-Extra: lint
Requires-Dist: vivarium-dependencies[lint]; extra == "lint"
Provides-Extra: dev
Requires-Dist: vivarium-gbd-mapping[docs,interactive,lint,test]; extra == "dev"
Provides-Extra: cluster
Provides-Extra: ci-github
Requires-Dist: vivarium-gbd-mapping[docs,lint,test]; extra == "ci-github"
Provides-Extra: ci-jenkins
Requires-Dist: vivarium-gbd-mapping[ci_github,cluster]; extra == "ci-jenkins"
Dynamic: license-file

GBD Mapping
===========

.. image:: https://badge.fury.io/py/vivarium-gbd-mapping.svg
    :target: https://badge.fury.io/py/vivarium-gbd-mapping

.. image:: https://readthedocs.org/projects/vivarium-gbd-mapping/badge/?version=latest
    :target: https://vivarium-gbd-mapping.readthedocs.io/en/latest/?badge=latest
    :alt: Latest Docs

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

The mapping modules are generated from GBD data by a separate, IHME-internal package,
``vivarium-gbd-mapping-generator``, which requires access to the IHME cluster and some of our
internally used data-access libraries. Mapping updates are managed by a maintainer toolchain, so
this shouldn't be an issue for consumers of this package.

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

 - Causes
 - Risks
 - Covariates
 - Etiologies
 - Sequelae

**Supported Python versions: 3.10, 3.11**

You can install ``vivarium-gbd-mapping`` from PyPI with pip:

.. code-block:: bash

   pip install vivarium-gbd-mapping

or build it from source by cloning the monorepo and installing this package:

.. code-block:: bash

   git clone https://github.com/ihmeuw/vivarium-suite.git
   cd vivarium-suite
   pip install libs/gbd-mapping


Development
+++++++++++

Set up this library in development mode with

.. code-block:: bash

   git clone https://github.com/ihmeuw/vivarium-suite.git
   cd vivarium-suite
   pip install -e 'libs/gbd-mapping[dev]'

To regenerate the mapping modules, see the ``vivarium-gbd-mapping-generator`` package.


`Check out the docs! <https://vivarium-gbd-mapping.readthedocs.io/en/latest/>`_
-------------------------------------------------------------------------------
