pyconvexity 0.4.8__py3-none-any.whl

pyconvexity/models/__init__.py

@@ -0,0 +1,195 @@
+"""
+Model management module for PyConvexity.
+
+Contains high-level operations for networks, components, and attributes.
+"""
+
+from pyconvexity.models.components import (
+    get_component_type,
+    get_component,
+    list_components_by_type,
+    insert_component,
+    create_component,
+    update_component,
+    delete_component,
+    list_component_attributes,
+    get_default_carrier_id,
+    get_bus_name_to_id_map,
+    get_component_by_name,
+    get_component_id,
+    component_exists,
+    get_component_carrier_map,
+)
+
+from pyconvexity.models.attributes import (
+    set_static_attribute,
+    set_timeseries_attribute,
+    get_attribute,
+    delete_attribute,
+    get_timeseries,
+    get_timeseries_metadata,
+    # Actual value functions
+    set_actual_static_value,
+    set_actual_timeseries_value,
+    get_actual_value,
+    clear_actual_value,
+    get_attribute_direct,
+)
+
+from pyconvexity.models.network import (
+    create_network,
+    get_network_info,
+    get_network_time_periods,
+    list_networks,
+    create_carrier,
+    get_network_config,
+    set_network_config,
+    get_component_counts,
+    get_first_network,
+    get_network_by_name,
+)
+
+# Import from new modules
+from pyconvexity.models.scenarios import (
+    list_scenarios,
+    get_scenario_by_name,
+    get_scenario_by_id,
+    Scenario,
+    # Actual scenario functions
+    get_actual_scenario_id,
+    get_or_create_actual_scenario,
+    has_actual_value,
+    ACTUAL_SCENARIO_PURPOSE,
+)
+
+from pyconvexity.models.results import (
+    get_solve_results,
+    get_yearly_results,
+    SolveResults,
+    YearlyResults,
+)
+
+from pyconvexity.models.carriers import (
+    list_carriers,
+    get_carrier_by_name,
+    get_carrier_by_id,
+    get_carrier_colors,
+    Carrier,
+)
+
+
+# Backward compatibility aliases
+def get_scenario(conn, scenario_id):
+    """Backward compatible alias for get_scenario_by_id."""
+    return get_scenario_by_id(conn, scenario_id)
+
+
+def create_scenario(conn, name, description=None, probability=None):
+    """
+    Create a new scenario (single network per database).
+
+    Args:
+        conn: Database connection
+        name: Scenario name
+        description: Optional description
+        probability: Optional probability for stochastic optimization
+
+    Returns:
+        Scenario ID
+    """
+    cursor = conn.execute(
+        """
+        INSERT INTO scenarios (name, description, probability)
+        VALUES (?, ?, ?)
+    """,
+        (name, description, probability),
+    )
+
+    scenario_id = cursor.lastrowid
+    return scenario_id
+
+
+def delete_scenario(conn, scenario_id):
+    """
+    Delete a scenario.
+
+    Args:
+        conn: Database connection
+        scenario_id: Scenario ID to delete
+
+    Raises:
+        ValidationError: If scenario doesn't exist
+    """
+    from pyconvexity.core.errors import ValidationError
+
+    # Delete the scenario (cascade will delete related data)
+    cursor = conn.execute("DELETE FROM scenarios WHERE id = ?", (scenario_id,))
+
+    if cursor.rowcount == 0:
+        raise ValidationError(f"Scenario with ID {scenario_id} not found")
+
+
+__all__ = [
+    # Component operations
+    "get_component_type",
+    "get_component",
+    "list_components_by_type",
+    "insert_component",
+    "create_component",
+    "update_component",
+    "delete_component",
+    "list_component_attributes",
+    "get_default_carrier_id",
+    "get_bus_name_to_id_map",
+    "get_component_by_name",
+    "get_component_id",
+    "component_exists",
+    "get_component_carrier_map",
+    # Attribute operations
+    "set_static_attribute",
+    "set_timeseries_attribute",
+    "get_attribute",
+    "delete_attribute",
+    "get_timeseries",
+    "get_timeseries_metadata",
+    # Actual value operations
+    "set_actual_static_value",
+    "set_actual_timeseries_value",
+    "get_actual_value",
+    "clear_actual_value",
+    "get_attribute_direct",
+    "get_actual_scenario_id",
+    "get_or_create_actual_scenario",
+    "has_actual_value",
+    "ACTUAL_SCENARIO_PURPOSE",
+    # Network operations
+    "create_network",
+    "get_network_info",
+    "get_network_time_periods",
+    "list_networks",
+    "create_carrier",
+    "list_carriers",
+    "get_network_config",
+    "set_network_config",
+    "get_component_counts",
+    "get_first_network",
+    "get_network_by_name",
+    # Scenario operations (backward compatible)
+    "create_scenario",
+    "list_scenarios",
+    "get_scenario",
+    "delete_scenario",
+    "get_scenario_by_name",
+    "get_scenario_by_id",
+    "Scenario",
+    # Results operations
+    "get_solve_results",
+    "get_yearly_results",
+    "SolveResults",
+    "YearlyResults",
+    # Carrier operations
+    "get_carrier_by_name",
+    "get_carrier_by_id",
+    "get_carrier_colors",
+    "Carrier",
+]