brushline.strategic.bau
The fixed-cycle baseline, budget/capacity enforcement, and optimized-versus-BAU comparison.
Business-as-usual strategic baseline.
The baseline expands a fixed cycle or an explicit action calendar into the same segment-period options used by the optimized portfolio. It is simulated like-for-like and compared on present cost, service, risk, and uncertainty.
- class brushline.strategic.bau.BauComparison(*, optimized_portfolio_id: str, bau_policy_id: str, instance_id: str, present_cost_delta: float, service_delta: float, risk_delta: float, uncertainty_delta: float, optimized_feasible: bool, bau_feasible: bool, like_for_like: bool, caveats: list[str] = <factory>, created_utc: datetime)[source]
Bases:
BaseModelOptimized-versus-BAU comparison.
- Parameters:
optimized_portfolio_id (str) – Optimized portfolio id.
bau_policy_id (str) – BAU policy id.
instance_id (str) – Instance id.
present_cost_delta (float) – BAU cost minus optimized cost.
service_delta (float) – Optimized service minus BAU service.
risk_delta (float) – Optimized risk minus BAU risk (negative is better).
uncertainty_delta (float) – Optimized uncertainty minus BAU uncertainty (negative is better).
optimized_feasible (bool) – Optimized feasibility.
bau_feasible (bool) – BAU feasibility.
like_for_like (bool) – Same instance and period scope.
caveats (list of str) – Comparison caveats.
created_utc (datetime) – Timezone-aware time.
- model_config = {'extra': 'forbid', 'frozen': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class brushline.strategic.bau.BauConfig(*, cycle_years: Annotated[int, Ge(ge=1), Le(le=30)] = 4, start_year: Annotated[int, Ge(ge=1900), Le(le=2200)] = 2026, action_id: str | None = None, enforce_budget: bool = True)[source]
Bases:
BaseModelFixed-cycle baseline settings.
- Parameters:
cycle_years (int) – Treatment cycle.
start_year (int) – First cycle year.
action_id (str or None) – Action to apply; None uses the first non-treatment-free option.
enforce_budget (bool) – Whether budget and capacity violations make the baseline infeasible.
- model_config = {'extra': 'forbid', 'frozen': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- exception brushline.strategic.bau.BauError[source]
Bases:
ValueErrorRaised when a BAU policy or comparison is inconsistent.
- class brushline.strategic.bau.BauPlan(*, schema_version: ~typing.Literal['brushline.strategic-bau.v1'] = 'brushline.strategic-bau.v1', policy_id: str, instance_id: str, config: ~brushline.strategic.bau.BauConfig, selections: list[~brushline.strategic.portfolio.PortfolioSelection], period_summary: list[~brushline.strategic.portfolio.PeriodSummary], total_cost: ~typing.Annotated[float, ~annotated_types.Ge(ge=0)], service_attainment: ~typing.Annotated[float, ~annotated_types.Ge(ge=0), ~annotated_types.Le(le=1)], risk: ~typing.Annotated[float, ~annotated_types.Ge(ge=0), ~annotated_types.Le(le=1)], uncertainty: ~typing.Annotated[float, ~annotated_types.Ge(ge=0), ~annotated_types.Le(le=1)], baseline_service: ~typing.Annotated[float, ~annotated_types.Ge(ge=0), ~annotated_types.Le(le=1)], baseline_risk: ~typing.Annotated[float, ~annotated_types.Ge(ge=0), ~annotated_types.Le(le=1)], baseline_uncertainty: ~typing.Annotated[float, ~annotated_types.Ge(ge=0), ~annotated_types.Le(le=1)], feasible: bool, violations: list[~brushline.strategic.portfolio.PortfolioViolation] = <factory>, created_utc: ~datetime.datetime)[source]
Bases:
BaseModelA fixed-cycle business-as-usual plan.
- Parameters:
schema_version ({"brushline.strategic-bau.v1"}) – Schema version.
policy_id (str) – Policy id.
instance_id (str) – Instance id.
config (BauConfig) – Baseline settings.
selections (list of PortfolioSelection) – Selected options.
period_summary (list of PeriodSummary) – Period totals.
total_cost (float) – Total cost.
service_attainment (float) – Service.
risk (float) – Risk.
uncertainty (float) – Uncertainty.
baseline_service (float) – No-treatment service.
baseline_risk (float) – No-treatment risk.
baseline_uncertainty (float) – No-treatment uncertainty.
feasible (bool) – Budget/capacity satisfied.
violations (list of PortfolioViolation) – Hard violations.
created_utc (datetime) – Timezone-aware time.
- model_config = {'extra': 'forbid', 'frozen': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- brushline.strategic.bau.build_bau_plan(*, policy_id: str, instance_id: str, segments: list[PortfolioSegment], periods: list[PortfolioPeriod], options: list[PortfolioOption], config: BauConfig | None = None, created_utc: datetime | None = None) BauPlan[source]
Expand and simulate a fixed-cycle BAU policy.
- Parameters:
policy_id (str) – Policy id.
instance_id (str) – Instance id.
segments (list of PortfolioSegment) – Segments.
periods (list of PortfolioPeriod) – Periods.
options (list of PortfolioOption) – Options.
config (BauConfig, optional) – Cycle settings.
created_utc (datetime, optional) – Creation time.
- Returns:
BauPlan – Baseline plan and outcomes.
- Raises:
BauError – When an option references an unknown segment or period.
- brushline.strategic.bau.compare_bau(optimized: StrategicPortfolio, bau: BauPlan, *, created_utc: datetime | None = None) BauComparison[source]
Compare an optimized portfolio with a BAU plan.
- Parameters:
optimized (StrategicPortfolio) – Optimized portfolio.
bau (BauPlan) – BAU plan.
created_utc (datetime, optional) – Comparison time.
- Returns:
BauComparison – Deltas and like-for-like status.