Skip to main content

TemporalShiftScenario

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.

A flexible run of duration at power that may wait up to slack for a cleaner hour on a time-varying intensities signal.

Notes

Equation: result evaluates mlsysim.solvers.TemporalShiftModel.solve; its contract owns the governing equations.

Assumptions: The intensity signal starts at the run’s release time and has one value per step; the named scenario supplies a fixed configuration rather than a measured grid trace unless its description says otherwise.

Excludes: Forecast error, capacity limits, and any signal-boundary choice beyond what the supplied intensities encode.

References

Derivation: The scenario binds declared inputs to TemporalShiftModel. That implementation documents its derivation and sources.

Examples

Execute the registered worked inputs; this is a modeled calculation.

>>> from mlsysim import Scenarios
>>> case = Scenarios.EveningReleaseTimeShift
>>> case.result.shifted
True

Attributes

Name Description
capacity_available
deferral_energy
duration
intensities
power
result Evaluate the configured inputs with mlsysim.solvers.TemporalShiftModel.solve.
slack
standby_power
step

intensities

Type: List[Quantity].

Declared default: required.

power

Type: Quantity.

Declared default: required.

duration

Type: Quantity.

Declared default: required.

slack

Type: Quantity.

Declared default: required.

step

Type: Optional[Quantity].

Declared default: None.

deferral_energy

Type: Optional[Quantity].

Declared default: None.

standby_power

Type: Optional[Quantity].

Declared default: None.

capacity_available

Type: Optional[List[bool]].

Declared default: None.

result

engine.scenario_types.TemporalShiftScenario.result

Evaluate the configured inputs with mlsysim.solvers.TemporalShiftModel.solve.

The returned typed result retains the solver’s documented units, assumptions, and feasibility semantics; this property adds no measurement or safety claim. Equation: result = TemporalShiftModel().solve(...) using the fields shown below.

Back to top