Add support for hierarchical modeling to the JSON format case file specifications

Open
#619 8 comments 0 reactions 1 assignee View on GitHub

Maintainers usually reply within 1 day

@abirchfield is already working on this.

Since Oct 13, 2026.

  • #653 by @nkoukpaizan — open

Assessment

This issue has not been assessed yet.

Description

documentation enhancement new case question
Summary

Expand the specs for JSON case file to include subsystems specifications and support hierarchical modeling. The spect should define subsystems as objects assembled from component models or other subsystems. Subsystems should connect to other subsystems through bus and signal ports.

@lukelowry @tsybinae @nkoukpaizan

Rationale

Hierarchical modeling is needed to support:

  • Partitioned numerical integration schemes
  • Coarse-grained paralelism
  • Graphical user interface for analysis of large systems (> 100,000 buses) that cannot be visualized as whole to a necessary detail
Description

Approach 1: Suggested approach is to keep the current JSON format for case files and append subsystem information after all component models are specified. In such implementation, the subsystem declaration would specify component models belonging to each subsystem and identify connection ports that are external to subsystems. Assuming that component models are level-0, the subsystems described in this way would be level-1 subsystems. This approach can be extended by specifying level-2 subsystems, which are assembled from level-1 subsystems.

Approach 2: Instead of separate stanzas for component models, level-1 subsystems, level-2 subsystems, etc., one could first create a subsystem and then add specs to all components of that subsystem to the JSON value corresponding to the subsystem key. The JSON file would have the same hierarchical structure as the system model.

Approach 1 is easier to manipulate, especially when system repartitioning to different subsystems is needed. Approach 2 may have advantage in instances where the case specifications need to be split in separate files.

Additional information

No response

Dominant language
C++
Stars
27
Forks
11
Avg merge
2d 21h
Merged PRs (30d)
15

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ORNL/GridKit

All issues in ORNL/GridKit

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.