reVX.config.transmission_layer_creation.LayerConfig

class LayerConfig(*, layer_name: str, description: str | None = None, attrs: Dict | None = None, include_in_h5: bool | None = True, values_are_costs_per_mile: bool | None = False, build: Dict[str, LayerBuildConfig])

Bases: BaseModel

Definition of friction, barrier, and costs processing JSON config file.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

Attributes

model_computed_fields
model_fields
layer_name	Name of layer in H5 file.
description	Optional description to store in attrs for layer.
attrs	Additional H5 dataset attributes for this layer.
include_in_h5	Flag to specify whether layer should be stored in H5 or not.
values_are_costs_per_mile	Option to specify that the values given represent $/mile.
build	Mapping of layer components used to build this layer.

layer_name: str

Name of layer in H5 file.

description: str | None

Optional description to store in attrs for layer.

attrs: Dict | None

Additional H5 dataset attributes for this layer.

include_in_h5: bool | None

Flag to specify whether layer should be stored in H5 or not.

values_are_costs_per_mile: bool | None

Option to specify that the values given represent $/mile.

If True, the values will be converted to $/CELL_DIST, which is what is ultimately used for routing.

build: Dict[str, LayerBuildConfig]

Mapping of layer components used to build this layer.

Keys are GeoTIFF or vector filepaths. Values are the LayerBuildConfig to use for that file.