ORNL · pelesh · May 8, 2025 · May 7, 2025 · May 8, 2025
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
@@ -1,25 +1,16 @@
-#
+# [[
+#  Author(s):
+#    - Slaven Peles <peless@ornl.gov>
+#]]
 
-add_subdirectory(MatPowerTesting)
 add_subdirectory(LinearAlgebra)
-add_subdirectory(DistributedGeneratorTest)
 
-if(TARGET SUNDIALS::kinsol)
-  add_subdirectory(Grid3Bus)
-endif()
+add_subdirectory(PowerFlow)
+add_subdirectory(PowerElectronics)
+add_subdirectory(Experimental)
 
 if(TARGET SUNDIALS::idas)
-  add_subdirectory(AdjointSensitivity)
-  add_subdirectory(RLCircuit)
-  add_subdirectory(Microgrid)
-  add_subdirectory(ScaleMicrogrid)
   add_subdirectory(PhasorDynamics)
-  if(GRIDKIT_ENABLE_IPOPT)
-    add_subdirectory(DynamicConstrainedOpt)
-    add_subdirectory(GenConstLoad)
-    add_subdirectory(GenInfiniteBus)
-    add_subdirectory(ParameterEstimation)
-  endif()
 endif()
 
 if(GRIDKIT_ENABLE_ENZYME)

diff --git a/...AdjointSensitivity/AdjointSensitivity.cpp → ...AdjointSensitivity/AdjointSensitivity.cpp b/...AdjointSensitivity/AdjointSensitivity.cpp → ...AdjointSensitivity/AdjointSensitivity.cpp
diff --git a/examples/AdjointSensitivity/CMakeLists.txt → ...imental/AdjointSensitivity/CMakeLists.txt b/examples/AdjointSensitivity/CMakeLists.txt → ...imental/AdjointSensitivity/CMakeLists.txt
diff --git a/examples/Experimental/CMakeLists.txt b/examples/Experimental/CMakeLists.txt
@@ -0,0 +1,14 @@
+# [[
+#  Author(s):
+#    - Slaven Peles <peless@ornl.gov>
+#]]
+
+if(TARGET SUNDIALS::idas)
+  add_subdirectory(AdjointSensitivity)
+  if(GRIDKIT_ENABLE_IPOPT)
+    add_subdirectory(DynamicConstrainedOpt)
+    add_subdirectory(GenConstLoad)
+    add_subdirectory(GenInfiniteBus)
+    add_subdirectory(ParameterEstimation)
+  endif()
+endif()
diff --git a/...ples/DynamicConstrainedOpt/CMakeLists.txt → ...ntal/DynamicConstrainedOpt/CMakeLists.txt b/...ples/DynamicConstrainedOpt/CMakeLists.txt → ...ntal/DynamicConstrainedOpt/CMakeLists.txt
diff --git a/...cConstrainedOpt/DynamicConstrainedOpt.cpp → ...cConstrainedOpt/DynamicConstrainedOpt.cpp b/...cConstrainedOpt/DynamicConstrainedOpt.cpp → ...cConstrainedOpt/DynamicConstrainedOpt.cpp
diff --git a/examples/GenConstLoad/CMakeLists.txt → .../Experimental/GenConstLoad/CMakeLists.txt b/examples/GenConstLoad/CMakeLists.txt → .../Experimental/GenConstLoad/CMakeLists.txt
diff --git a/examples/GenConstLoad/GenConstLoad.cpp → ...xperimental/GenConstLoad/GenConstLoad.cpp b/examples/GenConstLoad/GenConstLoad.cpp → ...xperimental/GenConstLoad/GenConstLoad.cpp
diff --git a/examples/GenInfiniteBus/CMakeLists.txt → ...xperimental/GenInfiniteBus/CMakeLists.txt b/examples/GenInfiniteBus/CMakeLists.txt → ...xperimental/GenInfiniteBus/CMakeLists.txt
diff --git a/examples/GenInfiniteBus/GenInfiniteBus.cpp → ...imental/GenInfiniteBus/GenInfiniteBus.cpp b/examples/GenInfiniteBus/GenInfiniteBus.cpp → ...imental/GenInfiniteBus/GenInfiniteBus.cpp
diff --git a/examples/ParameterEstimation/CMakeLists.txt → ...mental/ParameterEstimation/CMakeLists.txt b/examples/ParameterEstimation/CMakeLists.txt → ...mental/ParameterEstimation/CMakeLists.txt
diff --git a/...rameterEstimation/ParameterEstimation.cpp → ...rameterEstimation/ParameterEstimation.cpp b/...rameterEstimation/ParameterEstimation.cpp → ...rameterEstimation/ParameterEstimation.cpp
diff --git a/...ples/ParameterEstimation/lookup_table.hpp → ...ntal/ParameterEstimation/lookup_table.hpp b/...ples/ParameterEstimation/lookup_table.hpp → ...ntal/ParameterEstimation/lookup_table.hpp
diff --git a/examples/PowerElectronics/CMakeLists.txt b/examples/PowerElectronics/CMakeLists.txt
@@ -0,0 +1,12 @@
+# [[
+#  Author(s):
+#    - Slaven Peles <peless@ornl.gov>
+#]]
+
+add_subdirectory(DistributedGeneratorTest)
+
+if(TARGET SUNDIALS::idas)
+  add_subdirectory(RLCircuit)
+  add_subdirectory(Microgrid)
+  add_subdirectory(ScaleMicrogrid)
+endif()
diff --git a/...s/DistributedGeneratorTest/CMakeLists.txt → ...s/DistributedGeneratorTest/CMakeLists.txt b/...s/DistributedGeneratorTest/CMakeLists.txt → ...s/DistributedGeneratorTest/CMakeLists.txt
diff --git a/examples/DistributedGeneratorTest/DGTest.cpp → ...onics/DistributedGeneratorTest/DGTest.cpp b/examples/DistributedGeneratorTest/DGTest.cpp → ...onics/DistributedGeneratorTest/DGTest.cpp
diff --git a/examples/Microgrid/CMakeLists.txt → ...PowerElectronics/Microgrid/CMakeLists.txt b/examples/Microgrid/CMakeLists.txt → ...PowerElectronics/Microgrid/CMakeLists.txt
diff --git a/examples/Microgrid/Microgrid.cpp → .../PowerElectronics/Microgrid/Microgrid.cpp b/examples/Microgrid/Microgrid.cpp → .../PowerElectronics/Microgrid/Microgrid.cpp
diff --git a/examples/RLCircuit/CMakeLists.txt → ...PowerElectronics/RLCircuit/CMakeLists.txt b/examples/RLCircuit/CMakeLists.txt → ...PowerElectronics/RLCircuit/CMakeLists.txt
diff --git a/examples/RLCircuit/RLCircuit.cpp → .../PowerElectronics/RLCircuit/RLCircuit.cpp b/examples/RLCircuit/RLCircuit.cpp → .../PowerElectronics/RLCircuit/RLCircuit.cpp
diff --git a/examples/ScaleMicrogrid/CMakeLists.txt → ...Electronics/ScaleMicrogrid/CMakeLists.txt b/examples/ScaleMicrogrid/CMakeLists.txt → ...Electronics/ScaleMicrogrid/CMakeLists.txt
diff --git a/examples/ScaleMicrogrid/ScaleMicrogrid.cpp → ...tronics/ScaleMicrogrid/ScaleMicrogrid.cpp b/examples/ScaleMicrogrid/ScaleMicrogrid.cpp → ...tronics/ScaleMicrogrid/ScaleMicrogrid.cpp
diff --git a/examples/ScaleMicrogrid/SolutionKeys.hpp → ...ectronics/ScaleMicrogrid/SolutionKeys.hpp b/examples/ScaleMicrogrid/SolutionKeys.hpp → ...ectronics/ScaleMicrogrid/SolutionKeys.hpp
diff --git a/examples/PowerFlow/CMakeLists.txt b/examples/PowerFlow/CMakeLists.txt
@@ -0,0 +1,10 @@
+# [[
+#  Author(s):
+#    - Slaven Peles <peless@ornl.gov>
+#]]
+
+add_subdirectory(MatPowerTesting)
+
+if(TARGET SUNDIALS::kinsol)
+  add_subdirectory(Grid3Bus)
+endif()
diff --git a/examples/Grid3Bus/3bus.mat → examples/PowerFlow/Grid3Bus/3bus.mat b/examples/Grid3Bus/3bus.mat → examples/PowerFlow/Grid3Bus/3bus.mat
diff --git a/examples/Grid3Bus/CMakeLists.txt → examples/PowerFlow/Grid3Bus/CMakeLists.txt b/examples/Grid3Bus/CMakeLists.txt → examples/PowerFlow/Grid3Bus/CMakeLists.txt
diff --git a/examples/Grid3Bus/Grid3BusSys.cpp → examples/PowerFlow/Grid3Bus/Grid3BusSys.cpp b/examples/Grid3Bus/Grid3BusSys.cpp → examples/PowerFlow/Grid3Bus/Grid3BusSys.cpp
diff --git a/examples/Grid3Bus/README.md → examples/PowerFlow/Grid3Bus/README.md b/examples/Grid3Bus/README.md → examples/PowerFlow/Grid3Bus/README.md
diff --git a/examples/MatPowerTesting/CMakeLists.txt → .../PowerFlow/MatPowerTesting/CMakeLists.txt b/examples/MatPowerTesting/CMakeLists.txt → .../PowerFlow/MatPowerTesting/CMakeLists.txt
diff --git a/...MatPowerTesting/test_parse_branch_row.cpp → ...MatPowerTesting/test_parse_branch_row.cpp b/...MatPowerTesting/test_parse_branch_row.cpp → ...MatPowerTesting/test_parse_branch_row.cpp
diff --git a/...es/MatPowerTesting/test_parse_bus_row.cpp → ...ow/MatPowerTesting/test_parse_bus_row.cpp b/...es/MatPowerTesting/test_parse_bus_row.cpp → ...ow/MatPowerTesting/test_parse_bus_row.cpp
diff --git a/...es/MatPowerTesting/test_parse_gen_row.cpp → ...ow/MatPowerTesting/test_parse_gen_row.cpp b/...es/MatPowerTesting/test_parse_gen_row.cpp → ...ow/MatPowerTesting/test_parse_gen_row.cpp
diff --git a/...atPowerTesting/test_parse_gencost_row.cpp → ...atPowerTesting/test_parse_gencost_row.cpp b/...atPowerTesting/test_parse_gencost_row.cpp → ...atPowerTesting/test_parse_gencost_row.cpp
diff --git a/...s/MatPowerTesting/test_parse_matpower.cpp → ...w/MatPowerTesting/test_parse_matpower.cpp b/...s/MatPowerTesting/test_parse_matpower.cpp → ...w/MatPowerTesting/test_parse_matpower.cpp
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,17 @@
+# GridKit™ Usage Examples
+
+GridKit™ usage examples are organized in following way:
+- `Enzyme` directory contains Enzyme automatic differentiation examples.
+- `Experimental` directory contains examples of dynamic-constrained
+optimization.
+- `LinearAlgebra` has examples and tests for dense and sparse matrices in
+GridKit™.
+- `PhasorDynamics` contains examples describing use of GridKit™ for phasor
+domain dynamic simulations.
+- `PowerElectronics` has examples describing microgrid simulations with
+GridKit™.
+- `PowerFlow` contains examples of power flow steady-state simulations with
+GridKit™.
+
+Examples are also used as integration tests for GridKit™ and are run on CI
+pipeline.