Module buildstock_query.tools.upgrades_visualizer.plot_utils

Classes

class PlotParams (**data: Any)

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

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class PlotParams(BaseModel):
    enduses: list[str]
    savings_type: SavingsTypes
    change_type: Optional[str]
    upgrade: Optional[int]
    group_by: list[str] = Field(default_factory=list)
    filter_bldgs: list[int] = Field(default_factory=list)
    sync_upgrade: Optional[int] = None
    resolution: str = "annual"
    value_type: ValueTypes

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var change_type : Optional[str]

var enduses : list[str]

var filter_bldgs : list[int]

var group_by : list[str]

var resolution : str

var savings_type : SavingsTypes

var sync_upgrade : Optional[int]

var upgrade : Optional[int]

var value_type : ValueTypes

class SavingsTypes (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code

class SavingsTypes(str, Enum):
    absolute = "Absolute"
    savings = "Savings"
    percent_savings = "Percent Savings"

Ancestors

• builtins.str
• enum.Enum

Class variables

var absolute

var percent_savings

var savings

class ValueTypes (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code

class ValueTypes(str, Enum):
    total = "total"
    count = "count"
    mean = "mean"
    distribution = "distribution"
    scatter = "scatter"

Ancestors

• builtins.str
• enum.Enum

Class variables

var count

var distribution

var mean

var scatter

var total