Check region aggregation
¶
nomenclature check-region-aggregation
¶
nomenclature check-region-aggregation
Usage:
nomenclature check-region-aggregation [OPTIONS]
{input_data_file}
Perform region aggregation and validate against original data.
Applies model-specific region mappings to aggregate native
regions into common
regions (e.g., national data to R5 regions). Compares
aggregated results with
any pre-aggregated data in the input file and reports
differences.
Useful for quality control of model-reported regional data.
Example:
$ nomenclature check-region-aggregation input.xlsx
-
-processed
-data
results.xlsx
╭─
Arguments
──────────────────────────────────────────────────
─╮
│
*
input_data_file
<
path
>
Input IAMC data file (.xlsx
│
│
or .csv)
│
│
[required]
│
╰───────────────────────────────────────────────────────────────╯
╭─
Options
────────────────────────────────────────────────────
─╮
│
-
-workflow
-directory
<
path
>
Workflow directory with
│
│
codelists and mappings
│
│
[default:
│
│
/home/docs/checkouts/rea…
│
│
-
-definitions
<
str
>
Definitions folder name
│
│
[default: definitions]
│
│
-
-mappings
<
str
>
Mappings folder name
│
│
[default: mappings]
│
│
-
-processed
-data
<
path
>
Output file for processed
│
│
data
│
│
[default:
│
│
/home/docs/checkouts/rea…
│
│
-
-differences
<
path
>
Output file for
│
│
aggregation differences
│
│
-
-help
Show this message and
│
│
exit.
│
╰───────────────────────────────────────────────────────────────╯
nomenclature
A Python package for working with IAMC-style scenario data
Navigation
Installation
User Guide
API documentation
Command line interface
Validate YAML
Validate project
Check region aggregation
Export definitions
List missing variables
Run workflow
Validate scenarios
Convert Excel codelist to YAML
Parse model registration
Related Topics
Documentation overview
Command line interface
Previous:
Validate project
Next:
Export definitions