Skip to main content

DisclosurePenaltyScenario

Economics scenarios · Implementation: mlsysim/engine/scenario_definitions/economics.py.

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

Penalties for an incomplete account: days_withheld at daily_maximum each, plus others (name -> amount), all in USD.

Notes

Equation: The illustrative charge is days_withheld*daily_maximum plus the sum of supplied other charges.

Assumptions: Monetary values are plain USD scalars supplied by the caller.

Excludes: A statement of current law, legally applicable penalties, or adjudication of a particular event.

References

Derivation: The illustrative charge is days_withheld*daily_maximum plus the sum of supplied other charges. This is declared scenario accounting rather than a fitted empirical law.

Examples

>>> from mlsysim import Scenarios
>>> scenario = Scenarios.CruiseDisclosurePenalties
>>> value = scenario.per_day_penalty
>>> round(float(value), 3)
112500.0

Attributes

Name Description
daily_maximum
days_withheld
others
per_day_penalty USD accumulated across withheld days at the supplied daily amount; not a legal
total USD sum of the day-based charge and separately supplied other charges.

days_withheld

Type: float.

Declared default: required.

daily_maximum

Type: float.

Declared default: required.

others

Type: Dict[str, float].

Declared default: required.

per_day_penalty

engine.scenario_types.DisclosurePenaltyScenario.per_day_penalty

USD accumulated across withheld days at the supplied daily amount; not a legal determination.

Equation: days_withheld * daily_maximum.

total

engine.scenario_types.DisclosurePenaltyScenario.total

USD sum of the day-based charge and separately supplied other charges.

Equation: per_day_penalty + sum(others.values()).

Back to top