Releases: amptimal/surge
Releases · amptimal/surge
v0.1.2
Added
New crates
surge-dispatch— unified economic dispatch and unit commitment kernel.
TypedDispatchModel/DispatchRequest/solve_dispatchAPI covers DC
and AC SCED, DC SCUC, time-coupled multi-period dispatch, reliability
commitment, AC redispatch, and SCED-AC Benders decomposition through one
request surface with three orthogonal study axes (Formulation × Interval
Coupling × Commitment Policy). Includes reserve-product modeling, N-1
security screening (explicit contingencies or iterative screening),
HVDC co-dispatch, emissions and carbon pricing, and a ledger-first
DispatchSolutionwith an exactObjectiveTermaudit.surge-market— canonical market-formulation layer on top of
surge-dispatch. Provides standard reserve-product constructors
(regulation, synchronized, non-synchronized, ramping, reactive
headroom) and zonal-requirement builders, commitment helpers,
piecewise offer-curve construction, per-bus load aggregation,
startup/shutdown trajectory derivation, and time-window translators.
Adds a typed multi-stage workflow runner (MarketStage,
MarketWorkflow,solve_market_workflow) with commitment handoff
and dispatch pinning, the canonical two-stage DC SCUC → AC SCED
workflow, the AC SCED setup combinator (reactive-reserve filter,
commitment augmentation, bandable-subset producer pinning, AC warm
start, Q-bound overrides), and the AC refinement runtime
(RetryPolicynested grid of OPF / band / NLP / HVDC attempts with
feedback providers and commitment probes). Includes the GO Competition
Challenge 3 format adapter as the reference implementation.
Python
- New
surge.dispatchnamespace exposing the canonical dispatch API —
DispatchRequest,DispatchSolution, study-axis enums, timeline
helpers, and reserve/market/network configuration builders. - New
surge.marketnamespace withMarketConfig,MarketWorkflow,
WorkflowRunner,run_market_solve, reserve catalog constants,
penalty-curve builders, AC reconciliation helpers, and
violation-assessment utilities. - New
surge.market.go_c3namespace with a one-callload/
build_workflow/solve_workflow/export/saverecipe for the
GO C3 adapter. - Typed
.pyistubs for dispatch and market namespaces;surge.opf
namespace module added. - New
solve_scedbinding.
Optimization (surge-opf)
- AC-OPF Benders subproblem support that produces the optimality cuts
consumed bysurge-dispatch's SCED-AC Benders loop. - Canonical reactive-reserve modeling in AC-OPF with per-product
headroom/footroom constraints and deliverability caps. - HVDC co-optimization inside AC-OPF, including converter-terminal Q
constraints and per-link dispatch bands. - Generator P-Q capability curves, piecewise cost epigraph support, and
improved tap / phase-shifter / switched-shunt / SVC / TCSC handling. - Pre-solve model-reduction backend (
backends::reduce) that removes
bound-implied-zero columns and duplicate rows before handing the LP
to the chosen backend. - Canonical MIP gap schedule / progress monitor API so commitment
solves can target time-varying gap thresholds. - Expanded Gurobi and HiGHS backend coverage (MIP callbacks, incumbent
tracking, Benders-compatible LP resolves); improved COPT backend for
AC-OPF NLPs. - AC-OPF result envelope now carries the full objective-ledger audit,
and thesurge-solveCLI fails closed when the ledger audit fails.
Network Model (surge-network)
- First-class
DispatchableLoadwith offer schedules and reserve
participation. - Reserve market primitives:
ReserveProduct,ReserveDirection,
ReserveKind,QualificationRule,EnergyCoupling,
ZonalReserveRequirement,SystemReserveRequirement. - Generator extensions for reserve capability (regulation, spinning,
non-spinning) and startup tiers keyed by offline hours. - Flowgate and interface refinements, penalty-curve types, and power-
balance penalty configuration.
Shared Solution Types (surge-solution)
- New
economicsmodule defining the exactObjectiveBucket/
ObjectiveTerm/ObjectiveLedgerMismatch/SolutionAuditReport
contracts used bysurge-dispatchfor ledger-first cost reporting. - New
idsmodule with canonical resource-id helpers
(generator_resource_id,dispatchable_load_resource_id,
combined_cycle_plant_id,default_machine_id).
CLI (surge-bindings)
- New
refresh_activsg_pssehelper binary for regenerating the
ACTIVSg2000 case from upstream PSS/E data used in the dispatch
tutorial.
Documentation
- New per-crate docs:
surge-dispatch
andsurge-market. - New Tutorial 12 — DC dispatch on ACTIVSg with LMP heat maps, with a
companion notebook. - Expanded generated Python namespace surface to include
surge.dispatch,
surge.market, andsurge.market.go_c3. - Refreshed architecture, support matrix, crate index, and release
process to cover the new dispatch and market crates.
Changed
surge-bindingsbinaries published to crates.io now include the new
objective-ledger audit enforcement on AC-OPF outputs.- Workspace member count updated —
surge-dispatchandsurge-market
join the crates.io publication list immediately before
surge-bindings.
v0.1.1
Fixed
- Corrected several DC-SCOPF issues affecting angle-limit handling, HVDC and
MTDC power balance, piecewise-linear cost passthrough, corrective Hessian
sizing, loss-factor outputs, and HVDC contingency accounting.
Added
- Added co-optimized variable HVDC dispatch, PAR scheduled-interchange
treatment, soft generator limits, iterative loss-factor support, and the
related CLI and Python SCOPF options.
Changed
- DC-SCOPF now defaults to LP costs in Rust and Python for more robust HiGHS
behavior on large cases. surge-bindingsis now published on crates.io, and installation guidance now
leads withcargo install surge-bindingsandpip install surge-py.
Documentation
- Refreshed the quickstart, support matrix, SCOPF tutorial, CLI reference,
notebook, and crate docs to match the new defaults and release packaging.
v0.1.0
Surge v0.1.0
AC/DC power flow, OPF, contingency analysis, and HVDC solver engine.
Install
Rust:
cargo add surge-ac # or any of the 11 published cratesPython:
pip install surge-pyCLI:
cargo install surge-bindingsHighlights
- Full AC Newton-Raphson and Fast Decoupled power flow with KLU sparse factorization
- DC-OPF, AC-OPF (with Ipopt analytical Hessian), and Security-Constrained OPF
- N-1/N-2 contingency analysis with LODF screening and parallel execution
- LCC/VSC HVDC and multi-terminal DC network solving
- NERC-style ATC/AFC transfer capability analysis
- 10+ file formats: MATPOWER, PSS/E RAW/DYR, CGMES, XIIDM, UCTE, IEEE CDF, OpenDSS
- Python bindings with NumPy interop and typed stubs
- 13-crate workspace, edition 2024, MSRV 1.87
Changelog
Power Flow (surge-ac, surge-dc)
- AC Newton-Raphson solver with sparse KLU factorization and reactive power
limit enforcement. - AC Newton-Raphson warm-start variant with DC-initialized voltage angles.
- Fast Decoupled Power Flow (FDPF) with B-prime / B-double-prime splitting.
- DC power flow (B-theta) with sparse KLU factorization.
- Linear sensitivity matrices: PTDF, LODF, OTDF, BLDF, GSF, and N-2 LODF.
HVDC (surge-hvdc)
- LCC and VSC HVDC link modeling with sequential, block-coupled, and hybrid
AC/DC iteration strategies. - Multi-terminal DC (MTDC) network solver with converter loss modeling.
Security and Contingency (surge-contingency)
- N-1 branch and generator contingency analysis with parallel execution via
rayon. - N-2 branch-pair contingency analysis.
- LODF-based fast screening with configurable thresholds.
- P4 and P6 post-contingency post-dispatch workflow support.
- Local voltage-stress screening for voltage stability assessment.
- Corrective action modeling with topology and redispatch remediation.
Optimization (surge-opf)
- DC-OPF via sparse B-theta formulation with LMP extraction from power balance
duals. - AC-OPF via Ipopt NLP with exact analytical Hessian and LMP decomposition
(energy, congestion, loss components). - Security-Constrained OPF (SCOPF) with iterative constraint generation
(cutting-plane) and penalty slack formulation. - Optimal Transmission Switching (OTS) and Optimal Reactive Power Dispatch
(ORPD). - SOCP and SDP relaxation workflows.
- Pluggable solver backends: HiGHS (bundled), Gurobi, COPT, CPLEX (runtime
detected), Ipopt (link-time).
Transfer (surge-transfer)
- NERC-style ATC (Available Transfer Capability) workflows.
- AFC (Available Flowgate Capability) and multi-transfer studies via DFAX.
- AC transfer capability with thermal, voltage, and transient stability limits.
- TPL-001-5.1 compliance report generation (P1-P7 categories).
Network Model (surge-network)
- Comprehensive power system network model: buses, branches, generators,
loads, shunts, HVDC links, transformers (2- and 3-winding), switched shunts,
FACTS devices, storage (unified as generators withStorageParams). - Area, zone, and owner metadata for regional analysis.
- Contingency definition with branch, generator, and HVDC outage types plus
modification actions (tap, load, generation, shunt adjustments). - Flowgate and interface constraint definitions.
- Versioned native JSON schema (
surge-network-jsonv0.1.0) with Zstandard
compression and compact binary variants.
Topology (surge-topology)
- Node-breaker to bus-branch topology projection.
- Island detection and connectivity analysis.
- Topology rebuild workflows for retained switching studies.
File Formats (surge-io)
- MATPOWER
.mreader and writer. - PSS/E RAW reader and writer (v30-v36) with RAWX support.
- PSS/E DYR dynamics data reader (130+ model types).
- PSS/E sequence data reader (zero/positive/negative sequence impedances).
- CGMES 2.4.15 and CGMES 3.0 (CIM100) reader (29 import waves).
- XIIDM (PowSyBl) reader and writer including phase tap changers.
- UCTE
.uctreader. - IEEE Common Data Format (CDF) reader.
- OpenDSS
.dssreader for 3-phase distribution models. - COMTRADE reader for oscillography data.
- Surge native JSON, compressed JSON (Zstandard), and binary format
reader/writer.
Sparse Infrastructure (surge-sparse)
- Compressed Sparse Column (CSC) matrix with COO-to-CSC assembly.
- KLU sparse LU factorization with symbolic reuse and numeric refactor.
- Complex KLU solver for Y-bus admittance matrix operations.
Solution Types (surge-solution)
- Shared result contracts for power flow and OPF outputs.
- Replay-friendly solved state snapshots.
CLI (surge-bindings)
surge-solvebinary with solver methods:acpf,acpf-warm,fdpf,
dcpf,dc-opf,ac-opf,socp-opf,scopf,ots,orpd,
contingency,n-2,hvdc,injection-capability,nerc-atc.- Format auto-detection from file extension.
- JSON, text, and binary output modes.
- Solver backend selection via
--solver.
Python Bindings (surge-py)
surgePython package with typed stubs (.pyi) andpy.typedmarker.- Root-level entry points:
solve_ac_pf,solve_dc_pf,solve_dc_opf,
solve_ac_opf,solve_scopf,analyze_n1_branch,
analyze_n1_generator,analyze_n2_branch,load,save. - Namespaced APIs:
surge.powerflow,surge.optimization,
surge.contingency,surge.transfer,surge.dc,surge.io,surge.batch. - NumPy interop for voltage, angle, and sensitivity arrays.
- Parameter sweep with parallel scenario execution.
- Custom exception hierarchy (
SurgeErrorbase with solver-specific
subclasses). - Python 3.10 through 3.14 support.
Packaging and Build
- Rust workspace with 13 member crates, edition 2024, MSRV 1.87.
- Vendored HiGHS 1.13.1 for reproducible LP/QP builds.
- SuiteSparse/KLU linked for sparse factorization.
- Release profile:
opt-level=3, fat LTO, single codegen unit. - Generic public wheel builds: Linux x86_64, Linux aarch64, macOS aarch64,
Windows x86_64. - Optional targeted GitHub Release wheel artifacts for
x86-64-v4. - PolyForm Noncommercial 1.0.0 license with commercial dual-license option.
Documentation
- 8 user tutorials with Jupyter notebook companions.
- 15 per-crate reference guides.
- Architecture, validation evidence, and method fidelity documentation.
- CLI reference, Python API surface guide, and quickstart.
- Packaged example cases (IEEE 118-bus, ACTIVSg10k, pglib cases) in native
format with provenance records.
License
PolyForm Noncommercial 1.0.0. Commercial licensing available — contact licensing@amptimal.com.