Add simple function to encapsulate use of json and magic_enum TPLs (#294)

PhilipFackler · web-flow · commit aba33f7e1671 · 2025-10-29T21:23:34.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -30,6 +30,7 @@
 - Added more context information to JSON parser errors.
 - Added `Logger` class.
 - Added `CliOptions` for simple command-line parsing.
+- Added public function to encapsulate use of nlohmann/json and magic_enum from users.
 
 ## v0.1
 
diff --git a/examples/PhasorDynamics/Tiny/ThreeBus/Basic/CMakeLists.txt b/examples/PhasorDynamics/Tiny/ThreeBus/Basic/CMakeLists.txt
@@ -10,10 +10,6 @@ add_executable(ThreeBusBasicJson ThreeBusBasicJson.cpp)
 target_link_libraries(ThreeBusBasicJson
 	GRIDKIT::phasor_dynamics_components
 	GRIDKIT::solvers_dyn)
-target_include_directories(ThreeBusBasicJson
-    PRIVATE ${CMAKE_SOURCE_DIR}/third-party/nlohmann-json/include)
-target_include_directories(ThreeBusBasicJson
-    PRIVATE ${CMAKE_SOURCE_DIR}/third-party/magic-enum/include)
 install(TARGETS ThreeBusBasicJson RUNTIME DESTINATION ${_install_path})
 gridkit_example_add_file(ThreeBusBasic.json)
 
diff --git a/examples/PhasorDynamics/Tiny/ThreeBus/Basic/ThreeBusBasicJson.cpp b/examples/PhasorDynamics/Tiny/ThreeBus/Basic/ThreeBusBasicJson.cpp
@@ -17,10 +17,8 @@
 #include <Model/PhasorDynamics/ComponentLibrary.hpp>
 #include <Model/PhasorDynamics/SystemModel.hpp>
 #include <Model/PhasorDynamics/SystemModelData.hpp>
-#include <Model/PhasorDynamics/SystemModelDataJSONParser.hpp>
 #include <Solver/Dynamic/Ida.hpp>
 #include <Utilities/Testing.hpp>
-#include <nlohmann/json.hpp>
 
 using scalar_type = double;
 using real_type   = double;
@@ -117,7 +115,7 @@ int main(int argc, const char* argv[])
   // Create model data
   //
 
-  SystemModelData<scalar_type, index_type> data(json::parse(std::ifstream(input_file)));
+  auto data = parseSystemModelData(input_file);
 
   //
   // Instantiate system
diff --git a/examples/PhasorDynamics/Tiny/ThreeBus/Classical/CMakeLists.txt b/examples/PhasorDynamics/Tiny/ThreeBus/Classical/CMakeLists.txt
@@ -15,10 +15,6 @@ add_executable(ThreeBusClassicalJson ThreeBusClassicalJson.cpp)
 target_link_libraries(ThreeBusClassicalJson
     GRIDKIT::phasor_dynamics_components
     GRIDKIT::solvers_dyn)
-target_include_directories(ThreeBusClassicalJson
-    PRIVATE ${CMAKE_SOURCE_DIR}/third-party/nlohmann-json/include)
-target_include_directories(ThreeBusClassicalJson
-    PRIVATE ${CMAKE_SOURCE_DIR}/third-party/magic-enum/include)
 install(TARGETS ThreeBusClassicalJson RUNTIME DESTINATION ${_install_path})
 gridkit_example_add_file(ThreeBusClassical.json)
 
diff --git a/examples/PhasorDynamics/Tiny/ThreeBus/Classical/ThreeBusClassicalJson.cpp b/examples/PhasorDynamics/Tiny/ThreeBus/Classical/ThreeBusClassicalJson.cpp
@@ -17,10 +17,8 @@
 #include <Model/PhasorDynamics/ComponentLibrary.hpp>
 #include <Model/PhasorDynamics/SystemModel.hpp>
 #include <Model/PhasorDynamics/SystemModelData.hpp>
-#include <Model/PhasorDynamics/SystemModelDataJSONParser.hpp>
 #include <Solver/Dynamic/Ida.hpp>
 #include <Utilities/Testing.hpp>
-#include <nlohmann/json.hpp>
 
 using scalar_type = double;
 using real_type   = double;
@@ -117,7 +115,7 @@ int main(int argc, const char* argv[])
   // Create model data
   //
 
-  SystemModelData<scalar_type, index_type> data(json::parse(std::ifstream(input_file)));
+  auto data = parseSystemModelData(input_file);
 
   //
   // Instantiate system
diff --git a/examples/PhasorDynamics/Tiny/TwoBus/Basic/CMakeLists.txt b/examples/PhasorDynamics/Tiny/TwoBus/Basic/CMakeLists.txt
@@ -10,10 +10,6 @@ add_executable(TwoBusBasicJson TwoBusBasicJson.cpp)
 target_link_libraries(TwoBusBasicJson
 	GRIDKIT::phasor_dynamics_components
 	GRIDKIT::solvers_dyn)
-target_include_directories(TwoBusBasicJson
-    PRIVATE ${CMAKE_SOURCE_DIR}/third-party/nlohmann-json/include)
-target_include_directories(TwoBusBasicJson
-    PRIVATE ${CMAKE_SOURCE_DIR}/third-party/magic-enum/include)
 install(TARGETS TwoBusBasicJson RUNTIME DESTINATION ${_install_path})
 gridkit_example_add_file(TwoBusBasic.json)
 
diff --git a/examples/PhasorDynamics/Tiny/TwoBus/Basic/TwoBusBasicJson.cpp b/examples/PhasorDynamics/Tiny/TwoBus/Basic/TwoBusBasicJson.cpp
@@ -16,10 +16,8 @@
 #include <Model/PhasorDynamics/ComponentLibrary.hpp>
 #include <Model/PhasorDynamics/SystemModel.hpp>
 #include <Model/PhasorDynamics/SystemModelData.hpp>
-#include <Model/PhasorDynamics/SystemModelDataJSONParser.hpp>
 #include <Solver/Dynamic/Ida.hpp>
 #include <Utilities/Testing.hpp>
-#include <nlohmann/json.hpp>
 
 int main(int argc, const char* argv[])
 {
@@ -70,7 +68,7 @@ int main(int argc, const char* argv[])
   // Create model data
   //
 
-  SystemModelData<scalar_type, index_type> data(json::parse(std::ifstream(input_file)));
+  auto data = parseSystemModelData(input_file);
 
   //
   // Instantiate system model
diff --git a/examples/PhasorDynamics/Tiny/TwoBus/Ieeet1/CMakeLists.txt b/examples/PhasorDynamics/Tiny/TwoBus/Ieeet1/CMakeLists.txt
@@ -12,10 +12,6 @@ target_link_libraries(TwoBusIeeet1Json
 	GRIDKIT::phasor_dynamics_components
 	GRIDKIT::phasor_dynamics_signal
 	GRIDKIT::solvers_dyn)
-target_include_directories(TwoBusIeeet1Json
-    PRIVATE ${CMAKE_SOURCE_DIR}/third-party/nlohmann-json/include)
-target_include_directories(TwoBusIeeet1Json
-    PRIVATE ${CMAKE_SOURCE_DIR}/third-party/magic-enum/include)
 install(TARGETS TwoBusIeeet1Json RUNTIME DESTINATION ${_install_path})
 gridkit_example_add_file(TwoBusIeeet1.json)
 
diff --git a/examples/PhasorDynamics/Tiny/TwoBus/Ieeet1/TwoBusIeeet1Json.cpp b/examples/PhasorDynamics/Tiny/TwoBus/Ieeet1/TwoBusIeeet1Json.cpp
@@ -13,10 +13,8 @@
 #include <Model/PhasorDynamics/ComponentLibrary.hpp>
 #include <Model/PhasorDynamics/SystemModel.hpp>
 #include <Model/PhasorDynamics/SystemModelData.hpp>
-#include <Model/PhasorDynamics/SystemModelDataJSONParser.hpp>
 #include <Solver/Dynamic/Ida.hpp>
 #include <Utilities/Testing.hpp>
-#include <nlohmann/json.hpp>
 
 int main(int argc, const char* argv[])
 {
@@ -69,7 +67,7 @@ int main(int argc, const char* argv[])
   // Create model data
   //
 
-  SystemModelData<scalar_type, index_type> data = json::parse(std::ifstream(input_file));
+  auto data = parseSystemModelData(input_file);
 
   //
   // Instantiate and configure the system model
diff --git a/examples/PhasorDynamics/Tiny/TwoBus/Tgov1/CMakeLists.txt b/examples/PhasorDynamics/Tiny/TwoBus/Tgov1/CMakeLists.txt
@@ -12,10 +12,6 @@ target_link_libraries(TwoBusTgov1Json
 	GRIDKIT::phasor_dynamics_components
 	GRIDKIT::phasor_dynamics_signal
 	GRIDKIT::solvers_dyn)
-target_include_directories(TwoBusTgov1Json
-    PRIVATE ${CMAKE_SOURCE_DIR}/third-party/nlohmann-json/include)
-target_include_directories(TwoBusTgov1Json
-    PRIVATE ${CMAKE_SOURCE_DIR}/third-party/magic-enum/include)
 install(TARGETS TwoBusTgov1Json RUNTIME DESTINATION ${_install_path})
 gridkit_example_add_file(TwoBusTgov1.json)
 
diff --git a/examples/PhasorDynamics/Tiny/TwoBus/Tgov1/TwoBusTgov1Json.cpp b/examples/PhasorDynamics/Tiny/TwoBus/Tgov1/TwoBusTgov1Json.cpp
@@ -18,10 +18,8 @@
 #include <Model/PhasorDynamics/ComponentLibrary.hpp>
 #include <Model/PhasorDynamics/SystemModel.hpp>
 #include <Model/PhasorDynamics/SystemModelData.hpp>
-#include <Model/PhasorDynamics/SystemModelDataJSONParser.hpp>
 #include <Solver/Dynamic/Ida.hpp>
 #include <Utilities/Testing.hpp>
-#include <nlohmann/json.hpp>
 
 int main(int argc, const char* argv[])
 {
@@ -73,7 +71,7 @@ int main(int argc, const char* argv[])
   // Create model data
   //
 
-  SystemModelData<scalar_type, index_type> data = json::parse(std::ifstream(input_file));
+  auto data = parseSystemModelData(input_file);
 
   //
   // Instantiate and allocate the system model
diff --git a/src/Model/PhasorDynamics/CMakeLists.txt b/src/Model/PhasorDynamics/CMakeLists.txt
@@ -16,17 +16,25 @@ add_subdirectory(SynchronousMachine)
 
 add_subdirectory(SignalNode)
 
-install(
-  FILES
+gridkit_add_library(phasor_dynamics_core
+  SOURCES
+    SystemModelData.cpp
+  HEADERS
     BusBase.hpp
     Component.hpp
     ComponentData.hpp
     ComponentLibrary.hpp
     ComponentSignals.hpp
     SystemModel.hpp
     SystemModelData.hpp
-  DESTINATION
-    include/GridKit/Model/PhasorDynamics)
+  INCLUDE_DIRECTORIES
+    PRIVATE ${CMAKE_SOURCE_DIR}/third-party/nlohmann-json/include
+    PRIVATE ${CMAKE_SOURCE_DIR}/third-party/magic-enum/include)
+
+target_link_libraries(phasor_dynamics_components
+  INTERFACE GRIDKIT::phasor_dynamics_core)
+target_link_libraries(phasor_dynamics_components_dependency_tracking
+  INTERFACE GRIDKIT::phasor_dynamics_core)
 
 add_library(GRIDKIT::phasor_dynamics_components
   ALIAS phasor_dynamics_components)
diff --git a/src/Model/PhasorDynamics/SystemModelData.cpp b/src/Model/PhasorDynamics/SystemModelData.cpp
@@ -0,0 +1,34 @@
+#include "SystemModelData.hpp"
+
+#include <fstream>
+
+#include <Model/PhasorDynamics/SystemModelDataJSONParser.hpp>
+
+namespace GridKit
+{
+  namespace PhasorDynamics
+  {
+    SystemModelData<double, size_t> parseSystemModelData(std::istream& stream)
+    {
+      SystemModelData<double, size_t> data(json::parse(stream));
+      return data;
+    }
+
+    SystemModelData<double, size_t> parseSystemModelData(std::istream&& stream)
+    {
+      SystemModelData<double, size_t> data(json::parse(stream));
+      return data;
+    }
+
+    SystemModelData<double, size_t> parseSystemModelData(const std::filesystem::path& filePath)
+    {
+      auto stream = std::ifstream(filePath);
+      return parseSystemModelData(stream);
+    }
+
+    SystemModelData<double, size_t> parseSystemModelData(const std::string& fileName)
+    {
+      return parseSystemModelData(std::ifstream(fileName));
+    }
+  } // namespace PhasorDynamics
+} // namespace GridKit
diff --git a/src/Model/PhasorDynamics/SystemModelData.hpp b/src/Model/PhasorDynamics/SystemModelData.hpp
@@ -1,5 +1,7 @@
 #pragma once
 
+#include <filesystem>
+#include <istream>
 #include <optional>
 #include <string>
 #include <vector>
@@ -83,5 +85,15 @@ namespace GridKit
       std::vector<Ieeet1DataT>       exciter;      ///< Exciters within the model
       std::vector<SignalDataT>       signal;       ///< Signal nodes
     };
+
+    ///@{
+    /**
+     * @brief Generate system model data from a JSON input file
+     */
+    SystemModelData<double, size_t> parseSystemModelData(std::istream&);
+    SystemModelData<double, size_t> parseSystemModelData(std::istream&&);
+    SystemModelData<double, size_t> parseSystemModelData(const std::filesystem::path&);
+    SystemModelData<double, size_t> parseSystemModelData(const std::string&);
+    ///@}
   } // namespace PhasorDynamics
 } // namespace GridKit
