rubem.configuration.output_variables.OutputVariable

class OutputVariable(**data)[source]

Bases: BaseModel

One output variable of the model and what the run writes for it.

Parameters:

  • id – Short identifier (itp, bfw, …).

  • is_raster_series_enabled – Whether the raster series is written.

  • is_time_series_enabled – Whether the time series at the sample locations is written.

  • raster_filename_prefix – Prefix of the raster series files.

  • table_filename_prefix – Prefix of the time series 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

get

Deprecated dictionary-style access kept for one minor release.

Attributes

id

is_raster_series_enabled

is_time_series_enabled

raster_filename_prefix

table_filename_prefix

get(key, default=None)[source]

Deprecated dictionary-style access kept for one minor release.

Return type:

Any

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].