PlanningQuery#

class caf.ntem.queries.PlanningQuery(*years, scenario, version=Versions.EIGHT, label=None, output_zoning=ZoningSystems.NTEM_ZONE, filter_zoning_system=None, filter_zone_names=None, residential=True, employment=True, household=True)[source]#

Bases: QueryParams

Query class for NTEM planning data.

Parameters:

  • years (int) – Years to provide data / interpolate.

  • scenario (ntem_constants.Scenarios) – Scenario to provide data.

  • output_zoning (ntem_constants.ZoningSystems, optional) – Zoning system to output data in, NTEM zoning is default.

  • version (ntem_constants.Versions) – Version of NTEM data to use, version 8.0 by default

  • filter_zoning_system (ntem_constants.ZoningSystems | None, optional) – Zoning system to filter by, if None no spatial filter is performed.

  • filter_zone_names (list[str] | None, optional) – Zones to filter for, if None no spatial filter is performed.

  • residential (bool) – Whether to include residential data in the output data set. True by default.

  • employment (bool) – Whether to include employment data in the output data set. True by default.

  • household (bool) – Whether to include household data in the output data set. True by default.

  • label (str | None)

Attributes

name

Name of the query.

Methods

__init__(*years, scenario[, version, label, ...])

Initialise QueryParams.

query(conn[, include_zone_name])

Query NTEM database for Planning data using parameters defined on initialisation.

Attributes Documentation

name#