GridSim user manual
This manual covers using GridSim: building it, loading networks, running solves and studies, driving the desktop and
web apps, estimating historical GB grid states, and replaying the results. Each chapter stands alone, so start at the
task you need. The internals, equations and invariants are in the technical manual,
and the writing rules in STYLE.md.
Chapter files are named NNNN Chapter title.md, where NNNN is the chapter number. Chapters marked in preparation
are being written.
I. Getting going
| Ch |
Chapter |
What it covers |
| 1 |
Getting started |
Install the .NET SDK, build, run the tests, first solve. |
| 2 |
Loading networks |
Built-in cases, MATPOWER files, JSON case folders, the GB models and the case library. |
| 3 |
Configuration |
Environment variables, settings files and paths. |
| 4 |
Licensing and activation |
Tiers, bus limits, installing and checking a licence. |
II. Steady state
| Ch |
Chapter |
What it covers |
| 5 |
Running power flows |
The bare run, the report, engine choice, Q-limits, OLTC, solve exports, recorded runs. |
| 6 |
OPF, CPF, taps, distribution factors and losses |
dcpf, dcopf, acopf, cpf, taps, ptdf, lodf, losses. |
| 7 |
Three-phase distribution feeders |
dist3ph: unbalanced sweep, faults and estimation on feeders. |
| 34 |
Time series and hosting capacity |
qsts: quasi-static time series with timed tap changers, capacitor banks, inverters and storage; hosting: PV and load hosting capacity. |
III. The apps
| Ch |
Chapter |
What it covers |
| 8 |
The desktop app |
The WPF app (and how the web app differs): map, live view, pickers, replay. |
| 9 |
The web app and REST/WebSocket API |
GridSim.Web: the browser dashboard, /api/cases, /api/topology, /api/solve, /api/realtime, the /ws/sim stream, sessions and the replay-only mode. |
| 10 |
Analysis views |
SCADA, OPERATOR, MARKET, RP1, MECHANICAL, CYCLE and ASSETS tabs. |
| 33 |
The case editor |
GridSim.SchemaEditor: browse, edit, add, delete and rename case records, checked and saved byte for byte; --check. |
IV. Security and protection
| Ch |
Chapter |
What it covers |
| 11 |
Contingency analysis |
trip, screen, N-1, N-2, N-1-1, sweeps, stress, chain, cycle. |
| 12 |
Faults, short circuit and protection grading |
fault, iec60909, protection-check, grade. |
| 13 |
Battery storage studies |
--bess sites on chain and gda-replay: chemistries, dispatch policies, state of charge, losses and ageing. |
V. Dynamics
| Ch |
Chapter |
What it covers |
| 14 |
Frequency studies |
freq, transient, replay, domains, h0-study, fit-frequency, the live frequency view. |
| 15 |
RMS, modal and impedance stability |
stability (classical and RMS, CCT, RMS event studies), modal, impedance-stability, machine data files. |
| 16 |
Electromagnetic transients |
The emt verb: switching, faults and waveforms. |
| 17 |
Harmonic studies |
The harmonics verb: penetration, impedance scans and resonance, IEEE 519 compliance. |
VI. Events
VII. Estimation
VIII. Operations
| Ch |
Chapter |
What it covers |
| 25 |
Interposing live telemetry |
The RTU/SCADA interposer (IEC 104 and Modbus) and the IEEE C37.118 synchrophasor ingest pmu-ingest, live or recorded. |
| 26 |
Audit log, deployment and assurance |
--audit-log and its anchor, audit verify and audit show, the web host in Docker behind nginx, SSO, CI, and the assurance documents. |
| 27 |
Validation tools |
crossval, SE sidecars, physics-check, conformance, simdcheck. |
| 28 |
Benchmarking and GPU |
bench, batchsolve, gpucheck, simdcheck, the GPU backends, published results, renting a GPU server. |
IX. Reference
| Ch |
Chapter |
What it covers |
| 19 |
CLI reference |
Every verb, flag, default and exit code. (Its file keeps the number 19 because a test reads it.) |
| 29 |
Extending GridSim |
The extension seams: solvers, estimators, assets, formats. |
| 30 |
Troubleshooting |
Messages, exit codes and what to do about them. |
| 31 |
Exports and formats |
Every export and run-directory file, field by field. |
| 32 |
Glossary (in preparation) |
User-level terms; the full glossary is technical ch. 12. |