nomenclature

Allows managing definitions of data structures for model comparison projects and scenario analysis studies using the data format developed by the Integrated Assessment Modeling Consortium.
https://github.com/iamconsortium/nomenclature

Category: Climate Change
Sub Category: Integrated Assessment and Climate Policy

Keywords

energy-systems iamc-format integrated-assessment pyam python scenario scenario-data timeseries-format

Keywords from Contributors

integrated-assessment-scenarios macro-energy climate energy-system gams integrated-assessment-model strategic-planning data-warehouse modeling-tool

Last synced: about 1 hour ago
JSON representation

Repository metadata

A package to work with IAMC-style variable templates

README.md

nomenclature - Working with IAMC-format project definitions

Copyright 2021-2023 IIASA

This repository is licensed under the Apache License, Version 2.0 (the "License"); see
the LICENSE for details.

license
DOI
python
Code style: ruff
pytest
ReadTheDocs

Overview

The nomenclature package facilitates validation and processing of scenario data.
It allows managing definitions of data structures for model comparison projects and
scenario analysis studies using the data format developed by the
Integrated Assessment Modeling Consortium (IAMC).

A data structure definition consists of one or several "codelists".
A codelist is a list of allowed values (or "codes") for dimensions of IAMC-format data,
typically regions and variables. Each code can have additional attributes:
for example, a "variable" has to have an expected unit and usually has a description.
Read the SDMX Guidelines for more information on
the concept of codelists.

The nomenclature package supports three main use cases:

  • Management of codelists and mappings for model comparison projects
  • Validation of scenario data against the codelists of a specific project
  • Processing of scenario results, e.g. aggregation and renaming from "native regions" of
    a model to "common regions" (i.e., regions that are used for scenario comparison in a project).

The documentation is hosted on Read the Docs.

Integration with the pyam package

The nomenclature package is designed to complement the Python package pyam,
an open-source community toolbox for analysis & visualization of scenario data.
The pyam package was developed to facilitate working with timeseries scenario data
conforming to the format developed by the IAMC. It is used in ongoing assessments by
the IPCC and in many model comparison projects at the global and national level,
including several Horizon 2020 & Horizon Europe projects.

The validation and processing features of the nomenclature package
work with scenario data as a pyam.IamDataFrame object.

Read the pyam Docs for more information!

Getting started

To install the latest release of the package, please use the following command:

pip install nomenclature-iamc

Alternatively, it can also be installed directly from source:

pip install -e git+https://github.com/IAMconsortium/nomenclature#egg=nomenclature-iamc

See the User Guide
for the main use cases of this package.

Acknowledgement

This package is based on the work initially done in the Horizon 2020
openENTRANCE
project, which aims to develop, use and
disseminate an open, transparent and integrated modelling platform for assessing
low-carbon transition pathways in Europe.

Refer to the openENTRANCE/openentrance
repository for more information.

This project has received funding from the European Union’s Horizon
2020 research and innovation programme under grant agreement No. 835896.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: nomenclature
message: >-
  If you use this package please cite the doi
  corresponding to the release used
type: software
authors:
  - given-names: Philip
    family-names: Hackstock
    affiliation: >-
      International Institute for Applied Systems Analysis (IIASA)
    orcid: 'https://orcid.org/0000-0002-1482-1366'
  - given-names: David
    family-names: Almeida
    affiliation: >-
      International Institute for Applied Systems Analysis (IIASA)
    orcid: 'https://orcid.org/0009-0000-5458-7917'
  - given-names: Daniel
    family-names: Huppmann
    affiliation: >-
      International Institute for Applied Systems Analysis (IIASA)
    orcid: 'https://orcid.org/0000-0002-7729-7389'
  - given-names: Laura
    family-names: Wienpahl
    affiliation: >-
      International Institute for Applied Systems Analysis (IIASA)
    orcid: 'https://orcid.org/0000-0003-2049-8531'
  - given-names: Lucie
    family-names: Castella
    affiliation: >-
      International Institute for Applied Systems Analysis (IIASA)
    orcid: 'https://orcid.org/0000-0002-6049-0406'

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 2 days ago

Total Commits: 320
Total Committers: 10
Avg Commits per committer: 32.0
Development Distribution Score (DDS): 0.569

Commits in past year: 39
Committers in past year: 4
Avg Commits per committer in past year: 9.75
Development Distribution Score (DDS) in past year: 0.641

Name Email Commits
Philip Hackstock 2****k 138
Daniel Huppmann dh@d****t 106
David Almeida 5****a 42
Lucie Castella 6****a 13
GretchenSchowalter 1****r 10
Laura Wienpahl 5****n 4
Jan Ivar Korsbakken j****n@g****m 3
Matthew Gidden m****n@g****m 2
stickler-ci[bot] 4****] 1
Copilot 1****t 1

Committer domains:


Issue and Pull Request metadata

Last synced: 6 days ago

Total issues: 174
Total pull requests: 297
Average time to close issues: 5 months
Average time to close pull requests: 5 days
Total issue authors: 7
Total pull request authors: 9
Average comments per issue: 1.15
Average comments per pull request: 1.03
Merged pull request: 249
Bot issues: 0
Bot pull requests: 0

Past year issues: 16
Past year pull requests: 17
Past year average time to close issues: 19 days
Past year average time to close pull requests: 11 days
Past year issue authors: 3
Past year pull request authors: 4
Past year average comments per issue: 0.69
Past year average comments per pull request: 0.76
Past year merged pull request: 8
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/iamconsortium/nomenclature

Top Issue Authors

  • phackstock (102)
  • danielhuppmann (51)
  • dc-almeida (13)
  • korsbakken (3)
  • luciecastella (3)
  • byersiiasa (1)
  • danhooke (1)

Top Pull Request Authors

  • phackstock (119)
  • dc-almeida (73)
  • danielhuppmann (68)
  • luciecastella (15)
  • GretchenSchowalter (10)
  • gidden (5)
  • korsbakken (5)
  • Copilot (1)
  • byersiiasa (1)

Top Issue Labels

  • enhancement (43)
  • bug (33)
  • documentation (9)
  • question (2)

Top Pull Request Labels

  • enhancement (76)
  • bug (41)
  • documentation (12)
  • refactor (6)

Dependencies

.github/workflows/build-docs.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/nightly.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/publish.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/pytest.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite

Score: 6.756932389247553