Skip to content

Reorganize examples by model family #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 8, 2025
Merged

Conversation

pelesh
Copy link
Collaborator

@pelesh pelesh commented May 7, 2025

Description

As there are more examples being added to GridKit, it would be desirable to have them organized in a way that one can navigate them more easily. For instance, experimental examples should be in a directory separate from more commonly used examples.

Proposed changes

In this PR we reorganize examples in following directories:

  • Enzyme: Enzyme usage examples.
  • Experimental: Examples of dynamic-constrained optimization.
  • LinearAlgebra: Examples and tests for dense and sparse matrices in GridKit.
  • PhasorDynamics: all examples describing use of GridKit for phasor domain dynamic simulations.
  • PowerElectronics: examples describing microgrid simulations with GridKit.
  • PowerFlow: power flow steady-state simulations with GridKit and Matpower file parser.

These categories will help users and developers find all examples relevant for their work more easily. Typically users and developers would need to work with only one of those example families.

Checklist

  • All tests pass.
  • Code compiles cleanly with flags -Wall -Wpedantic -Wconversion -Wextra.
  • The new code follows GridKit™ style guidelines.
  • (N/A) There are unit tests for the new code.
  • The new code is documented.
  • The feature branch is rebased with respect to the target branch.

Further comments

None

@pelesh pelesh self-assigned this May 7, 2025
@pelesh pelesh added the cmake label May 7, 2025
Copy link
Collaborator

@abirchfield abirchfield left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is a much better structure

@pelesh pelesh merged commit c6ba874 into develop May 8, 2025
3 checks passed
@pelesh pelesh deleted the slaven/examples_reorg_dev branch June 10, 2025 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants