API reference

PowerIO

Julia binding of PowerIO, the power system data compiler, over C ABI 7.

using PowerIO
case = parse("case9.m")             # PioModule{BalancedNetwork}
net = case.value
length(net.buses)                   # 9
net.branches[1].reactance_pu
case.diagnostics                    # the reader's findings
emit(case, "matpower", "copy.m")    # same format: writes the original file unchanged
result = emit(case, "psse")         # another format, in memory
result.text
serialize(case, "case9.pio.json")   # PowerIO IR

parse reads a grid exchange source into a typed module. emit writes one. serialize and deserialize move PowerIO IR between PowerIO consumers. calc_* functions compute matrices and vectors. to_* functions construct another value type in memory. apply_updates! changes a module in place.

The C library resolves automatically: the bundled artifact, or a sibling powerio build during development. Point at a custom build with set_library!, the POWERIO_CAPI environment variable, or a persisted Preferences.jl override.

parse(path::AbstractString; format=nothing) -> PioModule
parse(io::IO; format=nothing, name=nothing) -> PioModule
parse(bytes::AbstractVector{UInt8}; format=nothing, name="<memory>") -> PioModule

Parse one grid exchange source into a typed module. A string is a path to a file or directory. An IO or byte vector is read in memory; name supplies the source name for format detection and diagnostics (an open file stream uses its path). format is a canonical format token such as "matpower", "psse", or "dss"; when omitted, the source name and content select the format.

The value type follows the source: MATPOWER, PSS/E, XIIDM, CGMES, and the other balanced formats give PioModule{BalancedNetwork}; OpenDSS, PMD JSON, and BMOPF give PioModule{MulticonductorNetwork}; PyPSA and GridFM folders give time series and scenario sets; GO Challenge 3 and OPFData give calculation instances and solutions.

These methods extend Base.parse so the bare name works after using PowerIO. Parse failures throw PowerIOError.

Active power with an explicit unit.

Apparent power with an explicit unit.

One emitted artifact.

Balanced network; keeps its module alive.

Calculation instance; keeps its module alive.

Calculation solution; keeps its module alive.

One update ready to apply.

Stable component identity.

DC operators built once over a balanced network.

Selected output location.

Detailed connectivity tables; keep their network alive.

One diagnostics list.

Completed emission inventory.

Owned structured JSON value.

One PioModule inside the C library.

Multiconductor network; keeps its module alive.

One network update.

Operating point; keeps its module alive.

One operating point update.

Reactive power with an explicit unit.

Scenario set; keeps its module alive.

Acquired input bytes or path.

Owned CSR matrix.

Owned string.

Time series; keeps its module alive.

One change from an update report.

Report of one applied update batch.

View of a module value; keeps the module alive.

Owned double vector.