powerio 0.5.0

Fast case parsing and conversion: "pandoc for power systems"
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

//! Read and write PowerWorld auxiliary `.aux` files.
//!
//! The reader is layered. [`parse_aux`] parses any auxiliary file into the
//! generic [`AuxFile`] — every `DATA` and `SCRIPT` section, with field lists,
//! value rows, and `SUBDATA` blocks intact — and knows the grammar from the
//! official format guide: legacy and concise headers, comma delimited (CSV)
//! sections, multiline field lists and value rows, `//` comments, quoting,
//! and `variablename:location` field suffixes. On top of it, the [`Network`]
//! mapping consumes the power flow core types (Bus, Load, Shunt, Gen,
//! Branch) by field name, so column order and extra columns don't matter.
//! Object types outside the core stay reachable through [`aux_sections`] and
//! survive the same format round trip byte for byte via the retained source
//! (see [`crate::write_as`]).
//!
//! The writer emits `DATA (Object, [fields]) { … }` blocks for the core
//! types, values in MW/MVAr/degrees, status as `Closed`/`Open`. Generator
//! cost, HVDC, and storage are not represented and are reported on write.
//!
//! `.pwb` binary cases are read (never written) by [`parse_pwb`]; see that
//! module for the decoded vintages and the parity evidence. `.pwd` display
//! files carry no case data, only the diagram; [`parse_pwd_file`] and
//! [`parse_pwd`] read the decoded substation coordinates.
//!
//! [`Network`]: crate::network::Network

mod auxiliary;
mod map;
mod objects;
mod pwb;
mod pwd;

#[cfg(test)]
mod tests;

use std::sync::Arc;

pub use auxiliary::{
    AuxFile, AuxObject, AuxRow, AuxScript, AuxSection, AuxSubData, parse_aux, write_aux,
};
pub(crate) use map::parse_powerworld_source;
pub use map::{aux_sections, write_powerworld};
pub use objects::{Contingency, contingencies, rating_set_names};
pub use pwb::parse_pwb;
pub use pwd::{PwdDisplay, PwdSubstation, parse_pwd, parse_pwd_display, parse_pwd_file};

use crate::Result;
use crate::network::Network;

/// Parse a PowerWorld `.aux` into a [`Network`], reading the Bus/Load/Shunt/
/// Gen/Branch `DATA` blocks by their declared field lists.
///
/// # Errors
/// [`crate::Error::FormatRead`] on malformed input or when the file has no
/// `DATA` sections.
pub fn parse_powerworld(content: &str) -> Result<Network> {
    // The caller owns `content` as a borrow, so retention needs one copy.
    let mut warnings = Vec::new();
    parse_powerworld_source(Arc::new(content.to_owned()), None, &mut warnings)
}