Skip to content

Commit

Permalink
Update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
danielhuppmann authored Dec 13, 2024
1 parent fdc851d commit 97c1c74
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,17 @@ Read more about the [IAMC data format](https://docs.ece.iiasa.ac.at/iamc.html).
This project uses the Python package [nomenclature-iamc](https://nomenclature-iamc.readthedocs.io)
for management of codelists and validation of scenario data in the IAMC data format.

> [!TIP]
> You can generate the project region and variable template xlsx spreadsheet yourself!
> 1. Install `nomenclature` (`pip install nomenclature-iamc`)
> 2. Run `$ nomenclature export-definitions . definitions.xlsx`
> [!TIP]
> For *users not comfortable working with GitHub repositories and yaml files*,
> the definitions for this project are available for download as an xlsx spreadsheet
> at https://files.ece.iiasa.ac.at/common-definitions/common-definitions-template.xlsx.
> [!NOTE]
> You can generate the project region and variable template xlsx spreadsheet yourself!
> 1. Clone/download this repository
> 2. Install the Pyhon package **nomenclature** (`pip install nomenclature-iamc`)
> 3. Run `$ nomenclature export-definitions . definitions.xlsx`
## Codelists and mappings

The folder `definitions` contains the "codelists", i.e., list of allowed variables and
Expand Down

0 comments on commit 97c1c74

Please sign in to comment.