reVReports.configs.SupplyCurveScenario#

class SupplyCurveScenario(*, source: Path, name: str, color: str = None)[source]#

Bases: BaseModelStrict

Inputs for an individual supply curve scenario

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

expand_user(value)

Expand user directory of input source paths

Attributes

source

Path to source file for this scenario

name

Name of this scenario (used for labeling in plots)

color

Color to use for this scenario in plots

source: Path#

Path to source file for this scenario

name: str#

Name of this scenario (used for labeling in plots)

color: str#

Color to use for this scenario in plots

classmethod expand_user(value)[source]#

Expand user directory of input source paths

Parameters:

value (pathlib.Path) – Input source path

Returns:

pathlib.Path – Source path with user directory expanded, if applicable