Skip to content

simplenet.cli

Command-line interface mirroring the MATLAB reduction_test.m workflow.

main 

main() -> None

simplenet - DC modified-Ward network reduction CLI.

Source code in src/simplenet/cli.py 
35
36
37
38
@click.group()
@click.version_option()
def main() -> None:
    """simplenet - DC modified-Ward network reduction CLI."""

reduce 

reduce(case_path: Path, excluded_path: Path, output_path: Path, summary_txt: Path | None, pf: bool, gentype_xlsx: Path | None) -> None

Run network reduction on CASE_PATH using buses listed in EXCLUDED_PATH.

 Examples simplenet reduce case9.m excluded.csv -o reduced.xlsx simplenet reduce matlab2_WECC.xlsx excluded_550.csv -o result.xlsx

Source code in src/simplenet/cli.py 
 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
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
@main.command()
@click.argument("case_path", type=click.Path(exists=True, dir_okay=False, path_type=Path))
@click.argument("excluded_path", type=click.Path(exists=True, dir_okay=False, path_type=Path))
@click.option(
    "-o", "--output", "output_path",
    type=click.Path(dir_okay=False, path_type=Path),
    required=True,
    help="Path to write the reduced multi-sheet xlsx.",
)
@click.option(
    "--summary-txt",
    type=click.Path(dir_okay=False, path_type=Path),
    default=None,
    help="Optional path to also dump the summary diary as a .txt file.",
)
@click.option(
    "--pf/--no-pf",
    default=True,
    help="Solve a DC PF on the full model before redistributing loads (default: --pf, matches Pf_flag=1).",
)
@click.option(
    "--gentype-xlsx",
    type=click.Path(exists=True, dir_okay=False, path_type=Path),
    default=None,
    help="If the case file is a MATPOWER .m that delegates Gen/Bus/etc. data to an xlsx, point to it here.",
)
def reduce(
    case_path: Path,
    excluded_path: Path,
    output_path: Path,
    summary_txt: Path | None,
    pf: bool,
    gentype_xlsx: Path | None,
) -> None:
    """Run network reduction on CASE_PATH using buses listed in EXCLUDED_PATH.

    \b
    Examples
        simplenet reduce case9.m excluded.csv -o reduced.xlsx
        simplenet reduce matlab2_WECC.xlsx excluded_550.csv -o result.xlsx
    """

    case = _load_case(case_path)
    if gentype_xlsx is not None:
        sup = load_xlsx(gentype_xlsx)
        if sup.bus.size:
            case.bus = sup.bus
        if sup.gen.size:
            case.gen = sup.gen
        if sup.branch.size:
            case.branch = sup.branch
        if sup.gencost is not None:
            case.gencost = sup.gencost
        if sup.gentype is not None:
            case.gentype = sup.gentype
        if sup.genfuel is not None:
            case.genfuel = sup.genfuel
        if sup.bus_name is not None:
            case.bus_name = sup.bus_name

    excluded = load_excluded_nodes(excluded_path)

    click.echo(f"Loaded {case.n_bus()} buses, {case.n_branch()} branches, {case.n_gen()} gens", err=True)
    click.echo(f"Excluding {excluded.size} buses", err=True)

    result = reduce_network(case, excluded, pf_flag=pf)

    dump_xlsx(result.reduced_case, output_path, summary=result.summary)
    if summary_txt is not None:
        summary_txt.write_text(result.summary)

    click.echo(result.summary)

info 

info(case_path: Path) -> None

Print summary statistics for CASE_PATH.

Source code in src/simplenet/cli.py 
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
@main.command()
@click.argument("case_path", type=click.Path(exists=True, dir_okay=False, path_type=Path))
def info(case_path: Path) -> None:
    """Print summary statistics for CASE_PATH."""

    case = _load_case(case_path)
    click.echo(f"baseMVA: {case.base_mva}")
    click.echo(f"buses:   {case.n_bus()}")
    click.echo(f"gens:    {case.n_gen()}")
    click.echo(f"branches:{case.n_branch()}")
    if case.gencost is not None:
        click.echo(f"gencost: {case.gencost.shape}")
    if case.gentype is not None:
        click.echo(f"gentype: {len(case.gentype)} entries")
    if case.genfuel is not None:
        click.echo(f"genfuel: {len(case.genfuel)} entries")
    if case.bus_name is not None:
        click.echo(f"bus_name: {len(case.bus_name)} entries")
    if case.dcline is not None:
        click.echo(f"dcline: {case.dcline.shape}")