Skip to content

ImportsConfig

Source

Configuration for adding Canadian imports time series.

>>> from r2x_reeds.sysmod.imports import ImportsConfig
>>> assert ImportsConfig is not None

Bases: PluginConfig. Inherited contracts remain defined by the base classes.

These fields are declared on this class. Required/default behavior is shown directly from source. Base-class fields also apply.

weather_year: int | None = Field(default=None, description='Weather year for time series alignment.')
solve_year: int | None = Field(default=None, description='ReEDS solve year used to select wide import values.')
canada_imports_fpath: Path | str | None = Field(default=None, description='Path to CSV file containing total Canadian import values.')
canada_szn_frac_fpath: Path | str | None = Field(default=None, description='Path to CSV file containing seasonal fraction data.')
hour_map_fpath: Path | str | None = Field(default=None, description='Path to CSV file containing hour mapping data.')

Continue with the Python API overview and transform contracts.