Top-level functions¶
- nomenclature.process(df, dsd, dimensions=None, processor=None)[source]¶
Function for validation and region aggregation in one step
This function is the recommended way of using the nomenclature package. It performs the following operations:
Validation against the codelists of a DataStructureDefinition
- Region-processing, which can consist of three parts:
Model native regions not listed in the model mapping will be dropped
Model native regions can be renamed
Aggregation from model native regions to “common regions”
Validation of consistency across the variable hierarchy
- Parameters:
- df
pyam.IamDataFrame
Scenario data to be validated and aggregated.
- dsd
DataStructureDefinition
Codelists that are used for validation.
- dimensionslist, optional
Dimensions to be used in the validation, defaults to all dimensions defined in dsd
- processor
RegionProcessor
, optional Region processor to perform region renaming and aggregation (if given)
- df
- Returns:
pyam.IamDataFrame
Processed scenario data
- Raises:
- ValueError
If the
pyam.IamDataFrame
fails the validation.