powerio-tx 0.11.7

Compiler infrastructure for power systems: parse, convert, validate, and lower grid models
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

//! Typed balanced network models and format implementations.
//!
//! Readers and writers cover MATPOWER `.m`, PowerModels JSON, PSS/E `.raw`,
//! PowerWorld `.aux`, pandapower JSON, PyPSA CSV, egret JSON, PSLF `.epc`,
//! PSS/E RAWX 35, PowSybl XIIDM and JIIDM 1.0 through 1.17, CIM CGMES 2.4.15 and 3.0,
//! Surge JSON,
//! and DeepMind OPFData JSON. PowerWorld `.pwb`, OPFData files, and the IEEE
//! Common Data Format are read
//! only. GO Challenge 3 defines a calculation and therefore parses only
//! through the top level `powerio::parse`, which returns its declared
//! `AcScucInstance` or `AcScucSolution`. `.pwd` display files parse through
//! the facade's `parse`, which returns `powerio.GeoLayer`.
//! Each reader produces a [`BalancedNetwork`]. The top level `powerio` facade
//! owns universal parsing and `emit`; this component crate supplies the typed
//! transmission implementation.
//!
//! A reader that retains source text can return those bytes when writing the
//! same format. Matrix and problem instance builders live in separate crates.
//!
//! SINCAL adapters are provided by `powerio_tnd::formats::sincal` and the
//! `powerio` facade. This model crate is independent of SQLite and integration.
//!
//! ```
//! use powerio_core::Source;
//! use powerio_tx::{parse, parse_format_id};
//!
//! let src = "\
//! function mpc = example
//! mpc.version = '2';
//! mpc.baseMVA = 100;
//! mpc.bus = [
//! \t1\t3\t0\t0\t0\t0\t1\t1\t0\t230\t1\t1.1\t0.9;
//! \t2\t1\t0\t0\t0\t0\t1\t1\t0\t230\t1\t1.1\t0.9;
//! ];
//! mpc.branch = [
//! \t1\t2\t0.01\t0.1\t0\t0\t0\t0\t0\t0\t1\t-360\t360;
//! ];
//! ";
//! let source = Source::from_memory("example.m", src.as_bytes().to_vec())?
//!     .with_format(parse_format_id("matpower")?);
//! let module = parse(source)?;
//! assert_eq!(module.value().buses().len(), 2);
//! # Ok::<(), powerio_core::Error>(())
//! ```

/// The powerio crate version, for provenance fields written by downstream
/// crates whose own version can drift from the core's.
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

mod collect;
pub mod contingency;
pub mod dc;
pub mod diagnostics;
pub mod dynamic;
pub mod error;
pub mod format;
pub mod gen_cost;
pub mod geo;
pub mod hvdc;
pub mod indexed;
pub mod islands;
pub mod lcc;
pub mod merge;
pub mod network;
mod normalize;
mod operations;
#[doc(hidden)]
pub mod version;

/// Unsupported implementation details shared with other PowerIO crates.
///
/// These items can change without notice and are not part of the
/// `powerio-tx` API. Applications should use the top level `powerio` facade.
#[doc(hidden)]
pub mod __internal {
    use powerio_core::ComponentId;

    #[doc(hidden)]
    pub use crate::format::goc3::{Goc3Document, Goc3Record, parse_goc3_instance_network};

    use crate::{BalancedNetwork, Generator, Load, OmittedFieldName};

    #[doc(hidden)]
    pub fn edit_load_assignment<R>(
        network: &mut BalancedNetwork,
        index: usize,
        component: &ComponentId,
        field: OmittedFieldName,
        edit: impl FnOnce(&mut Load) -> R,
    ) -> R {
        network.edit_load_assignment(index, component, field, edit)
    }

    #[doc(hidden)]
    pub fn edit_generator_assignment<R>(
        network: &mut BalancedNetwork,
        index: usize,
        component: &ComponentId,
        field: OmittedFieldName,
        edit: impl FnOnce(&mut Generator) -> R,
    ) -> R {
        network.edit_generator_assignment(index, component, field, edit)
    }
}

pub use contingency::{
    AutomaticOrder, AutomaticSpec, AutomaticTarget, BranchRef, Change, ChangeOp, ChangeUnit,
    ContingencyAction, ContingencyCase, ContingencyParsed, ContingencyResolution, ContingencySet,
    DefaultDispatch, DispatchBlock, DispatchEntry, DispatchLevel, DispatchedAction, Expanded,
    InterfaceMember, JoinName, MonitorScope, MonitorStatement, MonitoredParsed,
    MonitoredResolution, MonitoredSet, PsseEquipmentIndex, ResolvedCase, ResolvedComponent,
    ResolvedInterface, ResolvedVoltageScope, RetainedStatement, ScaledQuantity, SelectorGroup,
    SharedPsseEquipmentIndex, SkipRule, Subsystem, SubsystemDispatchRule, SubsystemParsed,
    SubsystemSelector, SubsystemSet, UnresolvedAction, UnresolvedMonitor, UnresolvedMonitorReason,
    UnresolvedReason,
};
pub use dc::BranchSusceptanceFormula;
pub use diagnostics::{Diagnostic, DiagnosticCode, DiagnosticSeverity, EmitFamily};
pub use error::{Error, ErrorCategory, Result};
pub use format::routing::{
    Detection, JSON_CLASSES, JsonClass, classify_json_bytes, classify_json_text,
    parse_distribution_format, parse_transmission_format,
};
#[cfg(test)]
pub(crate) use format::test_parse::{parse_file, parse_str};
pub use format::{
    EmitOptions, PwdDisplay, PwdSubstation, SOURCE_FORMAT_NAMES, TargetFormat, emit,
    emit_with_options, parse, parse_format_id, parse_target_format,
};

#[doc(hidden)]
pub use format::{
    __emit_pypsa_csv, __emit_pypsa_csv_with_options, __parse_opfdata_json,
    __parse_pypsa_csv_time_series,
};
pub use gen_cost::{GenCostPatch, GenCostPolicyReport, MissingGenCostPolicy, parse_gen_cost_csv};
pub use geo::{
    Canvas, CoordinateSpace, CoordsKind, ElementKey, GeoApplyReport, GeoFeature, GeoGeometry,
    GeoLayer, GeoMeta, GeoParsed, GeoTarget, Location, apply_substation_points,
    to_geo_layer_from_aux_substations, to_geo_layer_from_pwd, to_lonlat_from_pwd_mercator,
};
pub use hvdc::{HvdcInjections, HvdcTerminalInjection, HvdcTerminalPowers, HvdcTreatment};
pub use indexed::{ConnectivityReport, IndexCore, IndexedNetwork};
pub use islands::{Island, IslandPartition, IslandReferencePolicy, IslandReferenceReport};
pub use lcc::{LccConverterState, LccOperatingPoint};
pub use merge::{
    BusGroup, BusMerge, BusMergeRule, MergeSurvivor, MergedCharging, MergedFlows,
    PSSE_DEFAULT_ZERO_IMPEDANCE_THRESHOLD, RemovalReason, RemovedBranch, RemovedFlow,
    RemovedFlowMethod, RemovedFlows, RemovedSwitch, ZeroImpedanceRule,
};
pub use network::{
    AcDcConverterControlMode, ActivePowerControl, Area, BalancedNetwork, BoundaryLine,
    BoundaryLineGeneration, Branch, BranchCharging, BranchCurrentRatings, BranchRatingSet,
    BranchSolution, Bus, BusBreakerBus, BusId, BusType, BusbarSection, CalculatedBus, CaseMetadata,
    ComponentAlias, ComponentMetadata, ConnectivityNode, CurveStyle, DEFAULT_BASE_FREQUENCY,
    DcBusbar, DcConverterOperatingMode, DcConverterUnit, DcGround, DcLine, DcNode, DcPolarity,
    DcSeriesDevice, DcSwitch, DcSwitchKind, DcTerminal, DcTopologicalNode, DetailedConnectivity,
    DroopCurve, DroopCurveSegment, ExternalIdentifier, Extras, GenCaps, GenCost, Generator,
    GeneratorEnergySource, Hvdc, HvdcConverter, HvdcConverterKind, HvdcConvertersMode, Impedance,
    ImpedanceCorrection, ImpedanceCorrectionPoint, ImpedanceCorrectionVariable, InternalConnection,
    Junction, LineCommutatedConverter, LineCommutatedConverterOperatingMode,
    LineCommutatedConverterReactiveModel, Load, LoadVoltageModel, LoadingLimits,
    MinMaxReactiveLimits, OmittedField, OmittedFieldName, OperationalLimitGroup,
    ReactiveCapabilityCurve, ReactiveCapabilityCurvePoint, ReactiveLimits, Shunt, ShuntBlock,
    SolverParams, SourceFormat, StaticVarCompensator, StaticVarCompensatorRegulationMode, Storage,
    Subnetwork, Substation, Switch, SwitchKind, SwitchedShuntControl, SwitchedShuntMode,
    TapChanger, TapChangerKind, TapChangerRegulationMode, TapChangerStep, TemporaryLimit, Terminal,
    TerminalReference, TieLine, TopologyEndpoint, TopologyKind, TopologySwitch, Transformer3W,
    TransformerControl, TransformerControlMode, VoltageLevel, VoltageSourceConverter, Winding,
    calc_series_admittance_of, repair_values,
};
pub use normalize::{
    AngleDifferenceBounds, ClosedSwitchPolicy, NormalizeOptions, NormalizeReport,
    NormalizeSettings, NormalizeSourceRows, NormalizedNetwork, POWER_MODELS_ANGLE_BOUND_PAD,
    correct_angle_difference_bounds, stated_angle_difference_bounds,
};
pub use operations::{BusSubset, Selector, ZeroImpedanceReduction};