LowerZoneSystemInfo#

class caf.space.inputs.LowerZoneSystemInfo(*, name, shapefile, id_col, weight_data, data_col, weight_id_col, weight_data_year)#

Bases: ZoneSystemInfo

Lower level zone system input data for ZoneTranslationInputs.

Inherits from ZoneSystemInfo.

Parameters:

weight_data (Path) – File path to the weighting data for the lower zone system. This should be saved as a csv, and only needs two columns (an ID column and a column of weighting data)
data_col (str) – The name of the column in the weighting data csv containing the weight data.
weight_id_col (str) – The name of the columns in the weighting data containing the zone ids. This will be used to join the weighting data to the lower zoning, so the IDs must match, but the names of the ID columns may be different.
weight_data_year (int) – The year the weighting data comes from. This is used for writing files to the cache and is important for logging. If you don’t know this you should consider whether your weighting data is appropriate.
name (str)
shapefile (Path)
id_col (str)

Attributes Summary

`model_computed_fields`	A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
`model_config`	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
`model_fields`	Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

Attributes Documentation

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}#: A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'data_col': FieldInfo(annotation=str, required=True), 'id_col': FieldInfo(annotation=str, required=True), 'name': FieldInfo(annotation=str, required=True), 'shapefile': FieldInfo(annotation=Path, required=True), 'weight_data': FieldInfo(annotation=Path, required=True), 'weight_data_year': FieldInfo(annotation=int, required=True), 'weight_id_col': FieldInfo(annotation=str, required=True)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.