revrt.models.cost_layers.LayerConfig

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

Bases: BaseModel

Config for friction, barrier, and costs processing

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

layer_name	Name of layer in Zarr file
description	Optional description to store in attrs for layer
include_in_file	Flag to specify whether layer should be stored in the file
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 Zarr file

description: str | None

Optional description to store in attrs for layer

include_in_file: bool | None

Flag to specify whether layer should be stored in the file

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_size, 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.