Reorganize examples by model family #104
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
-Wall -Wpedantic -Wconversion -Wextra
.Further comments
None