GridKit Studio
A VS Code extension for inspecting GridKit power-system cases and reviewing dynamic
simulation results without leaving the editor.
Features
- Open
*.case.json files as interactive network diagrams.
- View networks with flat, tilted, or globe projections.
- Browse case parameters, variables, and available monitor signals.
- Configure and run a dynamic simulation from the active case.
- Plot recorded signals and display result values on the network.
- Keep simulation inputs, output, metadata, and derived stores together for review.
Case inspection does not require GridKit; running a simulation does.
Requirements
- VS Code 1.96 or later
- A local GridKit install prefix containing
bin/DynamicSimulation, only for
simulation runs
Configure the install prefix in VS Code settings:
{
"gridkit.installPrefix": "path/to/gridkit"
}
For a containerized environment with a pinned GridKit installation, see
gridkit-runenv on GitHub.
Getting started
- Install the GridKit Studio VSIX.
- Open a folder containing one or more
*.case.json files.
- Open a case file to display its network and populate the Studio views.
- If you plan to run a study, configure
gridkit.installPrefix.
- Use the Study view to configure, save, or run a dynamic simulation.
- Use Signals, Monitor, and Case to select recorded values, review
results, and inspect model data.
The Study view keeps per-case scratch settings. Run materializes the scratch study
to the case's natural *.solver.json sibling and launches it. Save exports to a
new, collision-safe solver file, and Load imports an existing compatible study.
Settings
Most users only need gridkit.installPrefix. Studio also provides settings for:
- monitor-spec overrides;
- result CSV retention;
- maximum frames and recorded columns per run;
- network projection and display layers; and
- the colormap shared by charts and network values.
The default safeguards allow up to 1,000,000 frames and 10,000 recorded columns.
Change studio.runs.maxFrames or studio.runs.maxColumns at workspace scope only
when the machine has sufficient memory and disk space for the requested run.
Supported files
Studio currently supports GridKit *.case.json cases and *.solver.json studies.
Monitor changes update the active case document's mon arrays, which determine what
the next simulation records. Existing run results are not modified.
Development
Build, package, and implementation notes live in the source repository under
apps/studio and docs/.
