RunParams#

class caf.ntem.inputs.RunParams(years, scenarios, output_zoning=ZoningSystems.NTEM_ZONE, version=Versions.EIGHT, filter_zoning_system=None, filter_zone_names=None, label=None)[source]#

Bases: ABC

Base class that defines the specification of queries for each data type.

Attributes

`filter_zone_names`	Zones to select from the data, must be in the names column of the zoning zones table.
`filter_zoning_system`	The zoning system to use when filtering data down
`label`
`output_zoning`	Zoning system to output the data in.
`version`	Version to produce outputs for.
`years`	Years to produce outputs.
`scenarios`	Scenarios to produce outputs

Methods

__init__(*args, **kwargs)

Attributes Documentation

Parameters:

years (list[int])
scenarios (list[Scenarios])
output_zoning (ZoningSystems)
version (Versions)
filter_zoning_system (ZoningSystems | None)
filter_zone_names (list[str] | None)
label (str | None)

filter_zone_names: list[str] | None = None#: Zones to select from the data, must be in the names column of the zoning zones table.

filter_zoning_system: ZoningSystems | None = None#: The zoning system to use when filtering data down

label: str | None = None#

output_zoning: ZoningSystems = 'ntem_zone'#: Zoning system to output the data in.

version: Versions = '8.0'#: Version to produce outputs for.

years: list[int][source]#: Years to produce outputs.

scenarios: list[Scenarios][source]#: Scenarios to produce outputs