PlanningParams

class caf.ntem.inputs.PlanningParams(years, scenarios, output_zoning=ZoningSystems.NTEM_ZONE, version=Versions.EIGHT, filter_zoning_system=None, filter_zone_names=None, label=None, residential=True, employment=True, household=True)

Bases: RunParams

Planning query parameters.

Attributes

employment	Whether to include employment data in the output.
household	Whether to include household data in the output.
residential	Whether to include residential data in the output.
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)

• residential (bool)

• employment (bool)

• household (bool)

employment: bool = True

Whether to include employment data in the output.

household: bool = True

Whether to include household data in the output.

residential: bool = True

Whether to include residential data in the output.

years: list[int]

Years to produce outputs.

scenarios: list[Scenarios]

Scenarios to produce outputs