Scenario Operations

Functions for managing scenarios.

create_scenario

create_scenario((conn, name, description=None, probability=None))

Create a new scenario (single network per database).

Parameters:

• conn: Database connection
• name: Scenario name
• description: Optional description
• probability: Optional probability for stochastic optimization

Returns:

Scenario ID

list_scenarios

list_scenarios((conn: sqlite3.Connection, include_system: bool = False) -> List[pyconvexity.models.scenarios.Scenario])

List scenarios (single network per database).

Parameters:

• conn: Database connection
• include_system: If True, include system scenarios (like "Actual")

Returns:

List of Scenario objects ordered by creation date

get_scenario

get_scenario((conn, scenario_id))

Backward compatible alias for get_scenario_by_id.

delete_scenario

delete_scenario((conn, scenario_id))

Delete a scenario.

Parameters:

• conn: Database connection
• scenario_id: Scenario ID to delete

Raises:

• ValidationError: If scenario doesn't exist