Skip to content

Docs are behind v3.77: tab renamed to Power Flow Simulation, two buttons undocumented, bundled systems count wrong #2

Description

@apetros

Found while reconciling tutorial narration against the running application, so
every point below is a comparison between what the docs say and what STEPSS
v3.77 actually shows on screen.

1. The third tab was renamed and the docs still use the old name

The application's third tab is Power Flow Simulation. The documentation
calls it Initialization throughout, and the string "Power Flow Simulation"
does not appear anywhere on the site.

Confirmed on STEPSS v3.77 (apt policy stepss reports 3.77), reading the tab
strip directly: System Data | Observables | Power Flow Simulation | Dynamic Simulation | Analysis | Codegen.

Pages that carry the old name:

  • gui/interface, the section heading and its body
  • gui/running
  • user-guide/power-flow
  • getting-started/quickstart

This one matters more than a normal doc drift, because a reader following the
instructions is looking for a tab that is not there.

2. Two buttons on that tab are undocumented

gui/interface says "Five buttons enable once a run succeeds" and lists:

Documented Present in v3.77
Add Helios results to data yes
Bus overview yes
Generators & SVCs yes
Adjustable transformers yes
Global power balance yes
not documented Save power flow solution
not documented Branch flows

So the count in that sentence is wrong as well as the list.

3. "The three bundled systems" is now four

gui/first-run and resources/releases both say three. The jar ships four
payloads:

my/stepss/payload/example-five-bus.zip
my/stepss/payload/example-kundur.zip
my/stepss/payload/example-nordic.zip
my/stepss/payload/example-six-bus.zip

and my/stepss/examples/examples.properties declares all four, with
six-bus.name=6-bus microgrid, six-bus.docs=https://github.com/SPS-L/stepss-6-bus-MG
and six-bus.svg=6bus.svg. test-systems/ separately lists four benchmark
networks but a different four, since it names the GB Network rather than the
6-bus microgrid, so the two pages disagree with each other as well as with the
application.

Suggested scope

Rename the tab across the four pages, correct the button list and its count in
gui/interface, and reconcile the bundled-systems count in gui/first-run,
resources/releases and test-systems/.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions