powerio 0.9.0

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

//! Typed balanced network models, parsers, and writers.
//!
//! Readers and writers cover MATPOWER `.m`, PowerModels JSON, PSS/E `.raw`,
//! PowerWorld `.aux`, pandapower JSON, PyPSA CSV, egret JSON, PSLF `.epc`, GO
//! Challenge 3 JSON, Surge JSON, and DeepMind OPFData JSON. PowerWorld `.pwb`
//! case files are read only, and GO Challenge 3 and OPFData JSON have no
//! canonical writer beyond same source echo; `.pwd` display files parse through
//! [`parse_display_file`].
//! Each reader produces a [`BalancedNetwork`]. [`BalancedNetwork::to_format`] returns the
//! serialized target and warnings for fields the target cannot represent. See
//! [`crate::format`] for format routing and fidelity rules.
//!
//! A reader that retains source text can return those bytes when writing the
//! same format. Matrix and problem instance builders live in separate crates.
//!
//! ```
//! use powerio::{parse_str, TargetFormat};
//!
//! 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 net = parse_str(src, "matpower")?.network;
//! assert_eq!(net.buses.len(), 2);
//! assert_eq!(net.to_format(TargetFormat::Matpower)?.text, src);
//! # Ok::<(), powerio::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");

pub mod dc;
pub mod diagnostics;
pub mod error;
pub mod format;
pub mod gen_cost;
pub mod geo;
pub mod indexed;
pub mod network;
mod normalize;
mod operations;
pub mod solver_tables;
pub mod version;

pub use dc::DcConvention;
pub use diagnostics::{
    DiagnosticCode, DiagnosticSeverity, Diagnostics, EmitFamily, StructuredDiagnostic,
};
pub use error::{Error, ErrorCategory, Result};
pub use format::routing::{
    Detection, JSON_CLASSES, JsonClass, classify_json_bytes, classify_json_text,
};
pub use format::{
    Conversion, DisplayData, DisplayFormat, Parsed, PwdDisplay, PwdSubstation, PypsaCsvOutputs,
    SOURCE_FORMAT_NAMES, SourceDocument, TargetFormat, WriteOptions, convert_file,
    convert_file_with_options, convert_str, convert_str_with_options, display_format_from_name,
    parse_bytes, parse_bytes_with_name, parse_deepmind_opfdata_json, parse_display_bytes,
    parse_display_file, parse_egret_json, parse_file, parse_goc3_json, parse_matpower,
    parse_matpower_file, parse_pandapower_json, parse_powermodels_json, parse_powerworld,
    parse_pslf, parse_psse, parse_str, parse_str_with_name, parse_surge_json,
    read_pypsa_csv_folder, target_format_from_name, write_as, write_as_with_options, write_dir,
    write_dir_with_options, write_egret_json, write_matpower, write_pandapower_json,
    write_powermodels_json, write_powerworld, write_pslf, write_psse, write_psse_rev,
    write_pypsa_csv_folder, write_surge_json,
};
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,
    geo_layer_from_aux_substations, geo_layer_from_pwd, pwd_mercator_to_lonlat,
};
pub use indexed::{ConnectivityReport, IndexCore, IndexedNetwork};
#[allow(deprecated)]
pub use network::Network;
pub use network::{
    Area, BalancedNetwork, Branch, BranchCharging, BranchCurrentRatings, BranchRatingSet,
    BranchSolution, Bus, BusId, BusType, DEFAULT_BASE_FREQUENCY, Diagnostic, Extras, GenCaps,
    GenCost, Generator, Hvdc, Impedance, Load, LoadVoltageModel, Shunt, ShuntBlock, SolverParams,
    SourceFormat, Storage, Switch, SwitchedShuntControl, SwitchedShuntMode, Transformer3W,
    TransformerControl, TransformerControlMode, Winding, series_admittance_of,
};
pub use normalize::{
    NormalizeOptions, NormalizeSourceRows, NormalizedNetwork, POWER_MODELS_ANGLE_BOUND_PAD,
};
pub use operations::Selector;
pub use powerio_diag::nonfinite;
pub use solver_tables::{
    NORMALIZED_SOLVER_TABLES_PASS, NormalizedSolverTables, SolverArcRow, SolverArcTerminal,
    SolverBranchRow, SolverBusRow, SolverCostRow, SolverGeneratorRow, SolverHvdcRow, SolverLoadRow,
    SolverShuntRow, SolverStorageRow, SolverSwitchRow, SolverTableIndex, SolverTableUnits,
};