pre-commit Github action

.github/workflows/pre_commit.yaml

@@ -0,0 +1,23 @@
+name: gridkit-bot pre-commit
+
+# Won't run on develop/main directly
+on: [pull_request]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        ref: ${{ github.event.pull_request.head.ref }}
+    - uses: actions/setup-python@v5.4.0
+    - uses: pre-commit/action@v3.0.1
+    - uses: EndBug/add-and-commit@v9.1.4
+      # Only need to try and commit if the action failed
+      if: failure()
+      with:
+        fetch: false
+        committer_name: GitHub Actions
+        committer_email: actions@github.com
+        message: Apply pre-commmit fixes 
+

.gitignore

@@ -4,4 +4,4 @@
 .vscode/
 *.DS_Store
 build/
-*.DS_Store
+*.DS_Store

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v19.1.7
+    hooks:
+    - id: clang-format
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    - id: check-toml
+    - id: forbid-new-submodules
+    - id: end-of-file-fixer
+    - id: check-yaml

CMakeLists.txt

@@ -150,6 +150,7 @@ add_subdirectory(src)
 # Create examples and tests
 enable_testing()
 add_subdirectory(examples)
+add_subdirectory(tests)
 
 export(EXPORT gridkit-targets FILE ${CMAKE_CURRENT_BINARY_DIR}/GridKitTargets.cmake)
 

CONTRIBUTING.md

@@ -331,4 +331,4 @@ To help enforce the above code style guidelines, we use autoformatting provided
 
 VS Code users can use `clang-format` to automatically format their code by installing the [C/C++ Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) and using the `Format Document` command in the command palette with the file to be formatted open. As well, you can enabled the `editor.formatOnSave` option to auto-format any file when you save it.
 
-Other users can use the [`git clang-format`](https://clang.llvm.org/docs/ClangFormat.html#git-integration) subcommand installed along with `clang-format` to auto-format all staged files.
+Other users can use the [`git clang-format`](https://clang.llvm.org/docs/ClangFormat.html#git-integration) subcommand installed along with `clang-format` to auto-format all staged files.

cmake/FindEnzyme.cmake

@@ -64,78 +64,44 @@ User may set:
 
 Author(s):
 - Asher Mancinelli <ashermancinelli@gmail.com>
+- Nicholson Koukpaizan <koukpaizannk@ornl.gov>
 
 ]]
 
-if(NOT ${CMAKE_C_COMPILER_ID} STREQUAL "Clang" OR NOT ${CMAKE_CXX_COMPILER_ID} STREQUAL "Clang")
-  message(FATAL_ERROR "Enzyme may only be enabled if building with Clang")
-endif()
+find_package(Enzyme REQUIRED CONFIG 
+             PATHS 
+             ${ENZYME_DIR}
+             ${ENZYME_DIR}/lib/cmake/Enzyme)
+message(STATUS "Enzyme configuration found: ${Enzyme_CONFIG}")
 
 find_library(ENZYME_LLVM_PLUGIN_LIBRARY
   NAMES
-  LLVMEnzyme-19.so
-  LLVMEnzyme-18.so
-  LLVMEnzyme-17.so
-  LLVMEnzyme-16.so
-  LLVMEnzyme-15.so
-  LLVMEnzyme-14.so
-  LLVMEnzyme-13.so
-  LLVMEnzyme-12.so
-  LLVMEnzyme-11.so
-  LLVMEnzyme-10.so
-  LLVMEnzyme-9.so
+  LLVMEnzyme-${Enzyme_LLVM_VERSION_MAJOR}.so
+  LLVMEnzyme-${Enzyme_LLVM_VERSION_MAJOR}.dylib
+  LLVMEnzyme-${Enzyme_LLVM_VERSION_MAJOR}.dll
   PATHS
-  ${ENZYME_DIR} $ENV{ENZYME_DIR}
-  ENV LD_LIBRARY_PATH ENV DYLD_LIBRARY_PATH
+  ${ENZYME_DIR}
+  ENV LD_LIBRARY_PATH 
+  ENV DYLD_LIBRARY_PATH
   PATH_SUFFIXES
-  lib64 lib)
+  lib64 lib
+  REQUIRED)
+message(STATUS "Enzyme LLVM plugin library: ${ENZYME_LLVM_PLUGIN_LIBRARY}")
 
-find_library(ENZYME_CLANG_PLUGIN_LIBRARY
-  NAMES
-  ClangEnzyme-19.so
-  ClangEnzyme-18.so
-  ClangEnzyme-17.so
-  ClangEnzyme-16.so
-  ClangEnzyme-15.so
-  ClangEnzyme-14.so
-  ClangEnzyme-13.so
-  ClangEnzyme-12.so
-  ClangEnzyme-11.so
-  ClangEnzyme-10.so
-  ClangEnzyme-9.so
-  PATHS
-  ${ENZYME_DIR} $ENV{ENZYME_DIR}
-  ENV LD_LIBRARY_PATH ENV DYLD_LIBRARY_PATH
-  PATH_SUFFIXES
-  lib64 lib)
-
-find_program(GRIDKIT_LLVM_LINK llvm-link)
-find_program(GRIDKIT_OPT opt)
-
-if("${GRIDKIT_LLVM_LINK}" STREQUAL "GRIDKIT_LLVM_LINK-NOTFOUND")
-  message(FATAL_ERROR "Could not find llvm-link! Will not be able to build Enzyme targets.")
-endif()
-
-if("${GRIDKIT_OPT}" STREQUAL "GRIDKIT_OPT-NOTFOUND")
-  message(FATAL_ERROR "Could not find opt! Will not be able to build Enzyme targets.")
-endif()
-
-message(STATUS "${ENZYME_CLANG_PLUGIN_LIBRARY};${ENZYME_LLVM_PLUGIN_LIBRARY}")
-if((NOT ${ENZYME_LLVM_PLUGIN_LIBRARY}) OR (NOT ${ENZYME_CLANG_PLUGIN_LIBRARY}))
-  set(ENZYME_CLANG_PLUGIN_LIBRARY CACHE FILEPATH "Path to Enzyme Clang plugin library")
-  set(ENZYME_LLVM_PLUGIN_LIBRARY CACHE FILEPATH "Path to Enzyme LLVM plugin library")
-  message(STATUS "Found Enzyme clang plugin: ${ENZYME_CLANG_PLUGIN_LIBRARY}")
-  message(STATUS "Found Enzyme LLVM plugin: ${ENZYME_LLVM_PLUGIN_LIBRARY}")
-  get_filename_component(ENZYME_LIBRARY_DIR ${ENZYME_CLANG_PLUGIN_LIBRARY} DIRECTORY CACHE "Enzyme library directory")
-else()
-  message(FATAL_ERROR "Enzyme library not found!"
-    " Set ENZYME_DIR to Enzyme's installation prefix.")
-endif()
+find_program(GRIDKIT_LLVM_LINK llvm-link
+             PATHS ${Enzyme_LLVM_BINARY_DIR}
+             REQUIRED)
+message(STATUS "llvm-link: ${GRIDKIT_LLVM_LINK}")
+
+find_program(GRIDKIT_OPT opt
+             PATHS ${Enzyme_LLVM_BINARY_DIR}
+             REQUIRED)
+message(STATUS "opt: ${GRIDKIT_OPT}")
 
 macro(enzyme_add_executable)
   set(options)
   set(oneValueArgs NAME)
-  set(multiValueArgs SOURCES LINK_LIBRARIES)
+  set(multiValueArgs SOURCES LINK_LIBRARIES INCLUDE_DIRECTORIES)
   cmake_parse_arguments(enzyme_add_executable "${options}" "${oneValueArgs}"
     "${multiValueArgs}" ${ARGN})
 
@@ -145,14 +111,32 @@ macro(enzyme_add_executable)
   set(PHASE5 "${CMAKE_CURRENT_BINARY_DIR}/${enzyme_add_executable_NAME}")
 
   set(OBJS "")
+  set(includes "${enzyme_add_executable_INCLUDE_DIRECTORIES}")
+
+  foreach(lib ${enzyme_add_executable_LINK_LIBRARIES})
+    get_target_property(include ${lib} INCLUDE_DIRECTORIES)
+    set(includes "${includes}" ${include})
+
+    get_target_property(libsource ${lib} SOURCES)
+    string(FIND "${libsource}" "TARGET" found)
+    if(NOT(${found} EQUAL -1))
+      list(APPEND LINKER_FLAGS "-Wl,${libsource}")
+    endif()
+  endforeach()
+
+  foreach(dir ${includes})
+    if(EXISTS ${dir})
+      list(APPEND INCLUDE_COMPILER_LIST "-I${dir}")
+    endif()
+  endforeach()
 
   foreach(SRC ${enzyme_add_executable_SOURCES})
     set(PHASE0 "${CMAKE_CURRENT_SOURCE_DIR}/${SRC}")
     set(PHASE1 "${CMAKE_CURRENT_BINARY_DIR}/${enzyme_add_executable_NAME}_${SRC}_compile.o")
     add_custom_command(
-      DEPENDS ${PHASE0}
+      DEPENDS ${PHASE0} 
       OUTPUT ${PHASE1}
-      COMMAND ${CMAKE_CXX_COMPILER} -flto -c ${PHASE0} -O2 -fno-vectorize -ffast-math -fno-unroll-loops -o ${PHASE1}
+      COMMAND ${CMAKE_CXX_COMPILER} -flto -c ${PHASE0} ${INCLUDE_COMPILER_LIST} -O2 -fno-vectorize -ffast-math -fno-unroll-loops -o ${PHASE1}
       COMMENT "Compiling ${SRC} to object file for target ${enzyme_add_executable_NAME}"
       )
     set(OBJS "${OBJS} ${PHASE1}")
@@ -182,9 +166,9 @@ macro(enzyme_add_executable)
     )
 
   add_custom_command(
-    DEPENDS ${PHASE4}
+    DEPENDS ${PHASE4} ${enzyme_add_executable_LINK_LIBRARIES}
     OUTPUT ${PHASE5}
-    COMMAND ${CMAKE_CXX_COMPILER} ${PHASE4} -o ${PHASE5}
+    COMMAND ${CMAKE_CXX_COMPILER} ${LINKER_FLAGS} ${PHASE4} -o ${PHASE5}
     )
 
   add_custom_target(

examples/AdjointSensitivity/AdjointSensitivity.cpp

@@ -57,13 +57,12 @@
  *
  */
 
-
-#include <iostream>
 #include <iomanip>
+#include <iostream>
 
 #include <Model/PowerFlow/Bus/BusSlack.hpp>
 #include <Model/PowerFlow/Generator4/Generator4.hpp>
-#include <SystemModel.hpp>
+#include <Model/PowerFlow/SystemModel.hpp>
 #include <Solver/Dynamic/Ida.hpp>
 #include <Utilities/Testing.hpp>
 
@@ -79,7 +78,7 @@
  */
 int main()
 {
-    using namespace ModelLib;
+    using namespace GridKit;
     using namespace AnalysisManager::Sundials;
     using namespace AnalysisManager;
     using namespace GridKit::Testing;
@@ -112,7 +111,6 @@ int main()
     idas->configureQuadrature();
     idas->initializeQuadrature();
 
-
     idas->runSimulation(0.1, 2);
     idas->saveInitialCondition();
 
@@ -138,30 +136,29 @@ int main()
     std::cout << "\n\nCost of computing objective function:\n\n";
     idas->printFinalStats();
 
-    const double g1 = Q[0];
+    const double g1  = Q[0];
     const double eps = 2e-3;
 
     // Compute gradient of the objective function numerically
-    std::vector<double> dGdp(model->size_opt());
+    std::vector<double> dGdp(model->sizeParams());
 
-    for (unsigned i=0; i<model->size_opt(); ++i)
+    for (unsigned i = 0; i < model->sizeParams(); ++i)
     {
-      model->param()[i] += eps;
-      idas->getSavedInitialCondition();
-      idas->initializeSimulation(t_init);
-      idas->initializeQuadrature();
-      idas->runSimulationQuadrature(t_final,100);
-
-      std::cout << "\n\nCost of computing derivative with respect to parameter "
-                << i << ":\n\n";
-      idas->printFinalStats();
-      double g2 = Q[0];
-
-      // restore parameter to original value
-      model->param()[i] -= eps;
-
-      // Evaluate dG/dp numerically
-      dGdp[i] = (g2 - g1)/eps;
+        model->param()[i] += eps;
+        idas->getSavedInitialCondition();
+        idas->initializeSimulation(t_init);
+        idas->initializeQuadrature();
+        idas->runSimulationQuadrature(t_final, 100);
+
+        std::cout << "\n\nCost of computing derivative with respect to parameter " << i << ":\n\n";
+        idas->printFinalStats();
+        double g2 = Q[0];
+
+        // restore parameter to original value
+        model->param()[i] -= eps;
+
+        // Evaluate dG/dp numerically
+        dGdp[i] = (g2 - g1) / eps;
     }
 
     // Compute gradient of the objective function using adjoint method
@@ -185,15 +182,15 @@ int main()
     int retval = 0;
     std::cout << "\n\nComparison of numerical and adjoint results:\n\n";
     double* neg_dGdp = idas->getAdjointIntegral();
-    for (unsigned i=0; i<model->size_opt(); ++i)
+    for (unsigned i = 0; i < model->sizeParams(); ++i)
     {
-        std::cout << "dG/dp" << i << " (numerical) = " <<      dGdp[i] << "\n";
+        std::cout << "dG/dp" << i << " (numerical) = " << dGdp[i] << "\n";
         std::cout << "dG/dp" << i << " (adjoint)   = " << -neg_dGdp[i] << "\n\n";
-        if(!isEqual(dGdp[i], -neg_dGdp[i], 10*eps))
-            --retval; 
+        if (!isEqual(dGdp[i], -neg_dGdp[i], 10 * eps))
+            --retval;
     }
 
-    if(retval < 0)
+    if (retval < 0)
     {
         std::cout << "The two results differ beyond solver tolerance!\n";
     }

examples/AdjointSensitivity/CMakeLists.txt

@@ -65,5 +65,3 @@ target_link_libraries(adjoint GRIDKIT::bus GRIDKIT::generator4 GRIDKIT::solvers_
 install(TARGETS adjoint DESTINATION bin)
 
 add_test(NAME AdjointSens COMMAND $<TARGET_FILE:adjoint> )
-
-

examples/CMakeLists.txt

@@ -56,7 +56,7 @@
 #
 
 add_subdirectory(MatPowerTesting)
-add_subdirectory(SparseTest)
+add_subdirectory(LinearAlgebra)
 add_subdirectory(DistributedGeneratorTest)
 
 if(TARGET SUNDIALS::kinsol)

examples/DistributedGeneratorTest/CMakeLists.txt

@@ -3,9 +3,9 @@
 
 
 add_executable(dgtest DGTest.cpp)
-target_link_libraries(dgtest GRIDKIT::powerelec_disgen
-                                GRIDKIT::powerelec_mircoline
-                                GRIDKIT::powerelec_microload
+target_link_libraries(dgtest GRIDKIT::power_elec_disgen
+                                GRIDKIT::power_elec_microline
+                                GRIDKIT::power_elec_microload
                                 GRIDKIT::solvers_dyn)
 
 add_test(NAME DistributedGeneratorTest    COMMAND $<TARGET_FILE:dgtest>)