surge-io 0.1.6

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
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

// SPDX-License-Identifier: LicenseRef-PolyForm-Noncommercial-1.0.0
use std::path::PathBuf;

use thiserror::Error;

// ---------------------------------------------------------------------------
// Error type
// ---------------------------------------------------------------------------

#[derive(Error, Debug)]
pub enum CgmesError {
    #[error("cannot read CGMES directory {path}: {source}")]
    ReadDirectory {
        path: PathBuf,
        #[source]
        source: std::io::Error,
    },
    #[error("cannot read directory entry in {path}: {source}")]
    ReadDirectoryEntry {
        path: PathBuf,
        #[source]
        source: std::io::Error,
    },
    #[error("no CGMES XML profiles found in {path}")]
    NoProfiles { path: PathBuf },
    #[error("cannot open CGMES archive {path}: {source}")]
    OpenArchive {
        path: PathBuf,
        #[source]
        source: std::io::Error,
    },
    #[error("cannot read CGMES zip archive {path}: {source}")]
    ReadArchive {
        path: PathBuf,
        #[source]
        source: zip::result::ZipError,
    },
    #[error("cannot read zip entry in {path}: {source}")]
    ReadArchiveEntry {
        path: PathBuf,
        #[source]
        source: zip::result::ZipError,
    },
    #[error("cannot create temporary directory for CGMES archive extraction: {0}")]
    CreateTempDir(#[source] std::io::Error),
    #[error("cannot extract archive entry to {path}: {source}")]
    ExtractArchiveEntry {
        path: PathBuf,
        #[source]
        source: std::io::Error,
    },
    #[error("zip archive {archive_path} contains an unsafe CGMES entry path: {entry_name}")]
    InvalidArchiveEntryPath {
        archive_path: PathBuf,
        entry_name: String,
    },
    #[error("zip archive {archive_path} contains duplicate CGMES profile paths: {entry_name}")]
    DuplicateArchiveEntryPath {
        archive_path: PathBuf,
        entry_name: String,
    },
    #[error("unsupported CGMES input: {0}")]
    UnsupportedInput(String),
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),
    #[error("XML error: {0}")]
    Xml(#[from] quick_xml::Error),
    #[error(
        "CGMES dataset is missing the SSH operating-point profile; include SSH for generator/load/converter set-points"
    )]
    MissingSshProfile,
    #[error(
        "CGMES dataset contains {count} unresolved BaseVoltage reference(s): {examples:?}. \
         Include the referenced EQ/EQBD BaseVoltage objects before loading."
    )]
    MissingBaseVoltageReferences { count: usize, examples: Vec<String> },
    #[error(
        "no TopologicalNodes found — include a TP profile, or provide a bus-breaker model \
         (ConnectivityNode + Switch) so topology can be synthesized automatically"
    )]
    NoTopology,
    /// CIM-03: object store size cap exceeded (protects against >1 GB allocations from
    /// malformed or adversarial CIM files).
    #[error("CIM file contains too many objects: {0}")]
    TooManyObjects(String),
}