rustpower 0.5.0

An experimental ECS world snapshot system built on Bevy, featuring structured archetype storage and manifest-based serialization.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256

"""Type stubs for the rustpower Python API v2.

Contract: docs/design/python_api_v2.md.
Core promise: solve() is always correct — topology changes (editor commits,
in_service toggles) trigger an automatic full rebuild; parameter changes via
element properties take the incremental path with warm starts.
"""
import numpy as np
import pandas as pd
from typing import Any, List, Optional, Tuple

# ---------------------------------------------------------------------------
# Element proxies (live views over ECS entities; hold no data themselves)
# ---------------------------------------------------------------------------

class BusHandle:
    """Bus proxy. Result properties are valid after solve()."""
    @property
    def id(self) -> int: ...
    @property
    def vn_kv(self) -> float: ...
    @property
    def vm_pu(self) -> float:
        """Voltage magnitude (p.u.) from the last solve."""
        ...
    @property
    def va_degree(self) -> float: ...
    @property
    def p_mw(self) -> float:
        """Net injected active power (MW) from the last solve."""
        ...
    @property
    def q_mvar(self) -> float: ...
    def set_load(self, p_mw: float, q_mvar: float) -> None:
        """Update all loads attached to this bus."""
        ...
    def set_gen(self, p_mw: float, vm_pu: float) -> None:
        """Update all PV generators attached to this bus (slack excluded)."""
        ...

class LoadHandle:
    """Load proxy. Property assignment = immediate-mode command."""
    @property
    def bus(self) -> int: ...
    p_mw: float
    """Active power consumption (MW). Assignment takes effect at next solve()."""
    q_mvar: float
    in_service: bool
    """Topology-class: assignment triggers a full rebuild at the next solve."""

class GenHandle:
    """PV generator proxy. Property assignment = immediate-mode command."""
    @property
    def bus(self) -> int: ...
    p_mw: float
    """Active power production (MW)."""
    vm_pu: float
    """Voltage magnitude setpoint (p.u.)."""
    in_service: bool

class LineHandle:
    """Line proxy. Flow properties are valid after solve()."""
    @property
    def from_bus(self) -> int: ...
    @property
    def to_bus(self) -> int: ...
    in_service: bool
    """Topology-class: assignment triggers a full rebuild at the next solve."""
    @property
    def p_from_mw(self) -> float: ...
    @property
    def q_from_mvar(self) -> float: ...
    @property
    def i_ka(self) -> float: ...

class TrafoHandle: ...
class ExtGridHandle: ...
class ShuntHandle: ...
class SGenHandle: ...
class SwitchHandle: ...

# ---------------------------------------------------------------------------
# Solve report
# ---------------------------------------------------------------------------

class SolveReport:
    """Returned by PowerGrid.solve(). Truthy iff converged."""
    @property
    def converged(self) -> bool: ...
    @property
    def iterations(self) -> int: ...
    @property
    def runtime_ms(self) -> float: ...
    @property
    def rebuild(self) -> str:
        """Rebuild level this solve triggered: 'full' | 'incremental'."""
        ...
    def __bool__(self) -> bool: ...

# ---------------------------------------------------------------------------
# Transactional editor (Unit of Work)
# ---------------------------------------------------------------------------

class GridEditor:
    """
    All topology mutations go through the editor. Commands are buffered
    (fused insert) and applied once on commit; an exception inside the
    `with` block aborts the transaction and leaves the grid unchanged.

        with grid.edit() as e:
            b, _ = e.add_bus(110.0)
            e.add_line(b0, b, 12.0)
        grid.solve()   # automatic full rebuild
    """
    def __enter__(self) -> "GridEditor": ...
    def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None: ...

    def add_bus(self, vn_kv: float, name: Optional[str] = None,
                vm_min: float = 0.9, vm_max: float = 1.1,
                zone: int = 0) -> Tuple[int, BusHandle]: ...
    def add_line(self, from_bus: int, to_bus: int, length_km: float,
                 std_type: Optional[str] = None, r_ohm_per_km: float = 0.1,
                 x_ohm_per_km: float = 0.1, c_nf_per_km: float = 0.0,
                 g_us_per_km: float = 0.0, parallel: int = 1,
                 max_i_ka: float = 0.0, name: Optional[str] = None) -> LineHandle: ...
    def add_load(self, bus: int, p_mw: float, q_mvar: float,
                 name: Optional[str] = None) -> LoadHandle:
        """p_mw > 0 indicates consumption."""
        ...
    def add_gen(self, bus: int, p_mw: float, vm_pu: float = 1.0,
                p_min: float = -1000.0, p_max: float = 1000.0,
                q_min: float = -1000.0, q_max: float = 1000.0,
                name: Optional[str] = None) -> GenHandle: ...
    def add_ext_grid(self, bus: int, vm_pu: float = 1.0, va_degree: float = 0.0,
                     name: Optional[str] = None) -> ExtGridHandle: ...
    def add_trafo(self, hv_bus: int, lv_bus: int, sn_mva: float = 1.0,
                  vn_hv_kv: float = 110.0, vn_lv_kv: float = 10.0,
                  vk_percent: float = 10.0, vkr_percent: float = 0.1,
                  pfe_kw: float = 0.0, i0_percent: float = 0.0,
                  shift_degree: float = 0.0, tap_pos: float = 0.0,
                  tap_neutral: float = 0.0, tap_step_percent: float = 1.25,
                  name: Optional[str] = None) -> TrafoHandle: ...
    def add_shunt(self, bus: int, q_mvar: float, p_mw: float = 0.0,
                  vn_kv: float = 110.0, step: int = 1,
                  name: Optional[str] = None) -> ShuntHandle: ...
    def remove(self, element: Any) -> None:
        """Remove an element by handle. Removing a bus removes attached
        elements. Phase 1: not rolled back by abort."""
        ...
    def commit(self) -> None: ...
    def abort(self) -> None: ...

# ---------------------------------------------------------------------------
# PowerGrid facade
# ---------------------------------------------------------------------------

class PowerGrid:
    """
    Core grid object. Three workflows:

    A. Batch:      PowerGrid("case.zip").solve(); grid.res_bus
    B. Parameter:  load.p_mw = p; grid.solve()        # incremental, warm start
    C. Topology:   with grid.edit() as e: ...; grid.solve()  # auto rebuild
    """
    def __init__(self, case_path: Optional[str] = None, qlim: bool = False,
                 **kwargs: Any):
        """qlim=True enforces generator reactive limits (PV buses are demoted
        to PQ when their Q output saturates, with an outer iteration loop)."""
        ...
    @classmethod
    def from_pandapower(cls, net: Any) -> "PowerGrid":
        """Build a PowerGrid directly from a live Python `pandapowerNet` object (from the Python `pandapower` library).
        
        The Python pandapower data model is discarded after ingestion."""
        ...
    def load_network(self, net: "Network") -> None:
        """Load a `rustpower.Network` object (the Rust-native parsed grid representation) into the grid.
        
        This clears all existing entities, re-ingests the network components,
        and rebuilds the grid. Existing element handles become invalid."""
        ...

    # -- element access (query-backed; returns None when not found) --------
    def bus(self, id: int) -> Optional[BusHandle]: ...
    def load(self, bus: Optional[int] = None,
             name: Optional[str] = None) -> Optional[LoadHandle]: ...
    def loads(self, bus: Optional[int] = None) -> List[LoadHandle]: ...
    def gen(self, bus: Optional[int] = None,
            name: Optional[str] = None) -> Optional[GenHandle]: ...
    def line(self, from_bus: int, to_bus: int) -> Optional[LineHandle]: ...

    # -- mutation gateway ---------------------------------------------------
    def edit(self) -> GridEditor: ...
    def set_base(self, f_hz: float = 50.0, sn_mva: float = 100.0) -> None: ...

    # -- solve ---------------------------------------------------------------
    def solve(self, v_init: Optional[np.ndarray] = None) -> SolveReport:
        """Run the power flow. Raises RuntimeError only on validation errors
        (empty grid, no slack); divergence is reported via a falsy report.
        v_init: Optional initial voltage guess (p.u. complex) for all buses."""
        ...
    def reset_state(self) -> None:
        """Reset the power flow solver state, clearing result vectors and resetting bus injections."""
        ...
    def enable_iwamoto(self, enable: bool) -> None:
        """Enable or disable the Iwamoto optimal multiplier solver dynamically at runtime."""
        ...

    # -- results -------------------------------------------------------------
    @property
    def res_bus(self) -> pd.DataFrame: ...
    @property
    def res_line(self) -> pd.DataFrame: ...
    @property
    def v(self) -> np.ndarray:
        """Complex bus voltages (p.u.). Original bus order."""
        ...
    @v.setter
    def v(self, value: np.ndarray) -> None:
        """Override the initial voltage guess (vinit) for all buses."""
        ...
    @property
    def converged(self) -> bool: ...
    @property
    def iterations(self) -> int: ...

    # -- overview -------------------------------------------------------------
    @property
    def n_bus(self) -> int: ...
    @property
    def n_line(self) -> int: ...
    def describe(self) -> pd.DataFrame: ...
    def display_case_buses(self) -> pd.DataFrame: ...
    def display_case_loads(self) -> pd.DataFrame: ...
    def post_process(self) -> None:
        """Explicitly run post-processing system to populate result components (usually done lazily)."""
        ...
    def get_parquet_case(self) -> bytes:
        """Serialize case topology/parameters to a ZIP archive of Parquet files (returns raw bytes)."""
        ...
    def get_parquet_results(self) -> bytes:
        """Serialize solved results (voltages, branch loading) to a ZIP archive of Parquet files (returns raw bytes)."""
        ...
    def load_parquet_case(self, zip_bytes: bytes) -> None:
        """Load a case-file ECS state from a ZIP archive of Parquet files (restores topology and parameters)."""
        ...

# ---------------------------------------------------------------------------
# IO (DTOs at the ingestion boundary; will move to rustpower.io in Phase 2)
# ---------------------------------------------------------------------------

class Network: ...

def load_csv_zip(path: str) -> Network: ...
def version() -> str: ...
def features() -> List[str]: ...