API Reference¶

This section is auto-generated from the package's PEP-compliant docstrings via mkdocstrings.

Public top-level API¶

from simplenet import (
    PowerCase,
    reduce_network,
    preprocess,
    kron_reduce,
    move_external_generators,
    redistribute_loads,
    run_dcpf,
    build_b_for_reduction,
    build_b_for_dcpf,
)
from simplenet.io import (
    load_m,
    load_xlsx,
    load_raw,
    dump_xlsx,
    load_excluded_nodes,
)

Result dataclasses¶

PowerCase - the core MATPOWER-style case representation.
ReductionResult - output of reduce_network.
PreprocessStats - counts of items removed during preprocessing.
KronResult - reduced admittance matrix
original internal block.
AssembleResult - reduced case
branch circuit numbers.
GenMoveResult - generator placement + bus mapping.
DCPFResult - DC power flow output.

Modules¶

Module	Purpose
`simplenet.case`	`PowerCase` data class and MATPOWER column constants
`simplenet.pipeline`	End-to-end reduction pipeline (`reduce_network`)
`simplenet.preprocess`	Drop isolated buses and out-of-service branches
`simplenet.ymatrix`	Sparse DC susceptance matrix builders
`simplenet.boundary`	Boundary bus identification
`simplenet.kron`	Core Kron reduction math
`simplenet.assemble`	Build reduced case from a Kron result
`simplenet.generators`	External generator placement (shortest electrical distance)
`simplenet.dcpf`	Standalone DC power flow
`simplenet.redistribute`	Load redistribution on the reduced model
`simplenet.io.matpower`	MATPOWER `.m` parser
`simplenet.io.xlsx`	`matlab2*.xlsx` reader / writer
`simplenet.io.psse`	PSS/E `.RAW` (v33) parser
`simplenet.io.csv_loader`	`excluded_nodes.csv` reader
`simplenet.cli`	Command-line interface