Skip to main content

WaterUseScenario

Sustainability scenarios · Implementation: mlsysim/engine/scenario_definitions/sustainability.py.

Construct this scenario with keyword inputs. The fields below show the types and defaults declared by this class.

An IT load held for period at each named WUE.

Notes

Equation: The result property composes mlsysim.solvers.WaterUseModel.solve with the stored fields and any derived properties described below.

Assumptions: Inputs use the units and validity ranges of mlsysim.solvers.WaterUseModel.solve. The named scenario supplies a fixed configuration rather than observations of a new run.

Excludes: Additional runtime effects or statistical guarantees beyond the cited solver contracts; no measurement is performed by this wrapper.

References

Derivation: The result property composes mlsysim.solvers.WaterUseModel.solve with the stored fields and any derived properties described below. Individual property contracts identify the exact accounting expression or reusable calculation. Registry entries supply the scenario inputs; this class does not turn them into measured outcomes.

Examples

Evaluate a named scenario using its declared inputs.

>>> from mlsysim import Scenarios
>>> scenario = Scenarios.ReferenceItLoadAnnualWater
>>> round(float(scenario.it_energy.magnitude), 4)
87600000.0

Attributes

Name Description
it_energy IT electricity consumption in kWh for constant load over the stated period.
it_power
period
result Return the modeled WaterUse result from mlsysim.solvers.WaterUseModel.solve.
wue

it_power

Type: Quantity.

Declared default: required.

period

Type: Quantity.

Declared default: required.

wue

Type: Dict[str, Quantity].

Declared default: required.

it_energy

engine.scenario_types.WaterUseScenario.it_energy

IT electricity consumption in kWh for constant load over the stated period.

Equation: (it_power * period).to('kWh').

result

engine.scenario_types.WaterUseScenario.result

Return the modeled WaterUse result from mlsysim.solvers.WaterUseModel.solve.

Equation: the scenario supplies its named fields to that solver. Returned quantity units, validity conditions, and omissions follow its calculation contract; this property adds no empirical calibration.

Back to top