surge-io 0.1.5

Surge I/O — Parser/writer for MATPOWER, PSS/E RAW, IEEE CDF, XIIDM, UCTE, and JSON case formats
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

// SPDX-License-Identifier: LicenseRef-PolyForm-Noncommercial-1.0.0
//! MATPOWER (.m) format reader and writer.

mod reader;
mod writer;

use std::path::Path;

use surge_network::Network;

pub use reader::MatpowerError as LoadError;
#[cfg(test)]
#[allow(unused_imports)]
pub(crate) use reader::{parse_file, parse_str};
pub use writer::MatpowerWriteError as SaveError;
#[cfg(test)]
#[allow(unused_imports)]
pub(crate) use writer::{to_string, write_file};

/// Load a MATPOWER case from disk.
pub fn load(path: impl AsRef<Path>) -> Result<Network, LoadError> {
    reader::parse_file(path.as_ref())
}

/// Load a MATPOWER case from an in-memory string.
pub fn loads(content: &str) -> Result<Network, LoadError> {
    reader::parse_str(content)
}

/// Save a MATPOWER case to disk.
pub fn save(network: &Network, path: impl AsRef<Path>) -> Result<(), SaveError> {
    writer::write_file(network, path.as_ref())
}

/// Serialize a MATPOWER case to an in-memory string.
pub fn dumps(network: &Network) -> Result<String, SaveError> {
    writer::to_string(network)
}