Package documentation <pyam:index>
genno.compat.pyam
genno.compat.pyam
genno.compat.pyam.computations
genno.compat.pyam.util
.compat.pyam
adds a iamc:
configuration file section.
genno.compat.pyam.iamc
Computer-specific configuration.
Invokes .Computer.convert_pyam
(plus extra computations) to reformat data from .Quantity
into a pyam.IamDataFrame
data structure. Each entry contains:
variable:
(str
)Variable name. This is used two ways: it is placed in 'Variable' column of the resulting IamDataFrame; and the reporting key to
~.Computer.get
the data frame is<variable>:iamc
.base:
(str
)Key for the quantity to convert.
select:
(dict
, optional)Keyword arguments to
.computations.select
.rename:
(dict
, optional)Passed to
convert_pyam
.replace:
(dict
, optional)Passed to
.convert_pyam
.drop:
(list
ofstr
, optional)Dimensions to drop (→ convert_pyam).
unit:
(str
, optional)Force output in these units (→ convert_pyam).
Additional entries are passed as keyword arguments to .collapse
, which is then given as the collapse callback for .convert_pyam
.
.collapse
formats the 'Variable' column of the IamDataFrame. The variable name replacements from the iamc variable names:
section of the config file are applied to all variables.