[Experimental] PGM CLI implementation #1297

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

Draft

TonyXiang8787 wants to merge 92 commits into main from feature/pgm-cli

+1,160 −8

.github/conda_pgm_env.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,7 @@ @@
     name: conda-pgm-env
     dependencies:
       # build env
-      - python=3.12
+      - python=3.14
       - pip
       - scikit-build-core
       # build deps
@@ Expand All / @@ -16,6 +16,7 @@ dependencies: @@
       - numpy
       - cmake
       - ninja
+      - cli11
       # test deps
       - pytest
       - pytest-cov
@@ Expand Down @@

.github/workflows/build-test-release.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -278,10 +278,15 @@ jobs: @@
               cmake --install build/
           - name: Build python
-            run: python -m pip install . --no-build-isolation --no-deps -C wheel.cmake=false
+            run: |
+              python conda_build_preparation.py
+              python -m pip install . --no-build-isolation --no-deps -C wheel.cmake=false
           - name: Test
-            run: pytest
+            run: |
+              pytest
+              power-grid-model --help
+              power-grid-model --version
       github-release:
         name: Create and release assets to GitHub
@@ Expand Down @@

CMakeLists.txt

-Original file line number
+Diff line change
@@ Expand Up / @@ -38,6 +38,7 @@ find_package(Boost REQUIRED) @@
     find_package(Eigen3 CONFIG REQUIRED)
     find_package(nlohmann_json CONFIG REQUIRED)
     find_package(msgpack-cxx REQUIRED)
+    find_package(CLI11 CONFIG REQUIRED)
     if(NOT WIN32)
         # thread
@@ Expand Down @@

cmake/pgm_version.cmake

-Original file line number
+Diff line change
@@ Expand Up / @@ -13,3 +13,10 @@ string( @@
         PGM_VERSION
         "${_PGM_VERSION_STRIPPED}"
     )
+    string(
+        REGEX REPLACE
+        "^([0-9]+)\\.[0-9]+(\\.[0-9]+)?.*"
+        "\\1"
+        PGM_VERSION_MAJOR
+        "${PGM_VERSION}"
+    )

conda_build_preparation.py

-Original file line number
+Diff line change
@@ -0,0 +1,31 @@
+    # SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+    #
+    # SPDX-License-Identifier: MPL-2.0
+    # This script modifies the pyproject.toml file to remove specific sections
+    #   [project.entry-points."cmake.root"] and [project.scripts]
+    # and deletes the run_pgm_cli.py file from the source directory.
+    # It is intended to be run as part of the conda build preparation process.
+    # So that conda environment will not be confused with PyPI style Python shim and entry points.
+    import re
+    from pathlib import Path
+    # Read the root pyproject.toml
+    pyproject_path = Path(__file__).parent / "pyproject.toml"
+    content = pyproject_path.read_text()
+    # Remove [project.entry-points."cmake.root"] section
+    content = re.sub(r'\n\[project\.entry-points\."cmake\.root"\].*?(?=\n\[|\Z)', "", content, flags=re.DOTALL)
+    # Remove [project.scripts] section
+    content = re.sub(r"\n\[project\.scripts\].*?(?=\n\[|\Z)", "", content, flags=re.DOTALL)
+    # Write back to pyproject.toml
+    pyproject_path.write_text(content)
+    # Remove run_pgm_cli.py file
+    run_pgm_cli_path = (
+        Path(__file__).parent / "src" / "power_grid_model" / "_core" / "power_grid_model_c" / "run_pgm_cli.py"
+    )
+    run_pgm_cli_path.unlink(missing_ok=True)

power_grid_model_c/CMakeLists.txt

-Original file line number
+Diff line change
@@ Expand Up / @@ -5,3 +5,4 @@ @@
     add_subdirectory("power_grid_model")
     add_subdirectory("power_grid_model_c")
     add_subdirectory("power_grid_model_cpp")
+    add_subdirectory("power_grid_model_cli")

power_grid_model_c/power_grid_model_c/CMakeLists.txt

-Original file line number
+Diff line change
@@ Expand Up / @@ -31,6 +31,8 @@ file( @@
     target_link_libraries(power_grid_model_c PRIVATE power_grid_model)
+    target_compile_definitions(power_grid_model_c PRIVATE PGM_VERSION="${PGM_VERSION}")
     target_sources(
         power_grid_model_c
         PUBLIC
@@ Expand All / @@ -44,7 +46,7 @@ set_target_properties( @@
         power_grid_model_c
         PROPERTIES
             VERSION ${PGM_VERSION}
-            SOVERSION ${PGM_VERSION}
+            SOVERSION ${PGM_VERSION_MAJOR}
             INTERPROCEDURAL_OPTIMIZATION_RELEASE TRUE
             INTERPROCEDURAL_OPTIMIZATION_RELWITHDEBINFO TRUE
     )
@@ Expand Down @@

power_grid_model_c/power_grid_model_c/include/power_grid_model_c/handle.h

-Original file line number
+Diff line change
@@ Expand Up @@
      */
     PGM_API void PGM_clear_error(PGM_Handle* handle);
+    /**
+     * @brief Get the version of the Power Grid Model library.
+     *
+     * @return A pointer to a zero-terminated string representing the version.
+     */
+    PGM_API char const* PGM_version(void);
     #ifdef __cplusplus
     }
     #endif
@@ Expand Down @@

power_grid_model_c/power_grid_model_c/src/handle.cpp

-Original file line number
+Diff line change
@@ Expand Up / @@ -18,6 +18,8 @@ using namespace power_grid_model; @@
     using power_grid_model_c::clear_error;
     using power_grid_model_c::compile_time_safe_cast;
+    constexpr char const* version = PGM_VERSION;
     } // namespace
     // create and destroy handle
@@ Expand Down Expand Up / @@ -52,3 +54,4 @@ char const** PGM_batch_errors(PGM_Handle const* handle) { @@
         return handle_ref.batch_errs_c_str.data();
     }
     void PGM_clear_error(PGM_Handle* handle) { clear_error(handle); }
+    char const* PGM_version(void) { return version; }

power_grid_model_c/power_grid_model_cli/CMakeLists.txt

-Original file line number
+Diff line change
@@ -0,0 +1,33 @@
+    # SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+    #
+    # SPDX-License-Identifier: MPL-2.0
+    add_executable(power_grid_model_cli
+      main.cpp
+      cli_options.cpp
+      pgm_calculation.cpp
+    )
+    target_link_libraries(power_grid_model_cli PRIVATE power_grid_model_c)
+    target_link_libraries(power_grid_model_cli PRIVATE power_grid_model_cpp)
+    target_link_libraries(power_grid_model_cli PRIVATE CLI11::CLI11)
+    set_property(TARGET power_grid_model_cli PROPERTY INSTALL_RPATH_USE_LINK_PATH FALSE)
+    set_property(TARGET power_grid_model_cli PROPERTY OUTPUT_NAME "power-grid-model")
+    if(APPLE)
+      set_property(TARGET power_grid_model_cli PROPERTY INSTALL_RPATH "@loader_path/../${CMAKE_INSTALL_LIBDIR}")
+    elseif(UNIX) # Linux, BSD (not Windows/macOS)
+      set_property(TARGET power_grid_model_cli PROPERTY INSTALL_RPATH "$ORIGIN/../${CMAKE_INSTALL_LIBDIR}")
+    endif()
+    target_compile_definitions(
+        power_grid_model_cli
+        PRIVATE PGM_ENABLE_EXPERIMENTAL
+    )
+    install(
+        TARGETS power_grid_model_cli
+        EXPORT power_grid_modelTargets
+        COMPONENT power_grid_model
+    )

power_grid_model_c/power_grid_model_cli/cli_functions.hpp

-Original file line number
+Diff line change
@@ -0,0 +1,59 @@
+    // SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+    //
+    // SPDX-License-Identifier: MPL-2.0
+    #include <power_grid_model_cpp.hpp>
+    #include <filesystem>
+    #include <map>
+    #include <ostream>
+    #include <set>
+    #include <vector>
+    namespace power_grid_model_cpp {
+    struct CLIResult {
+        int exit_code;
+        bool should_exit;
+        operator bool() const { return should_exit || exit_code != 0; }
+    };
+    // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
+    struct ClIOptions {
+        std::filesystem::path input_file;
+        std::vector<std::filesystem::path> batch_update_file;
+        std::filesystem::path output_file;
+        PGM_SerializationFormat input_serialization_format{PGM_json};
+        std::vector<PGM_SerializationFormat> batch_update_serialization_format;
+        bool is_batch{false};
+        double system_frequency{50.0};
+        Idx calculation_type{PGM_power_flow};
+        Idx calculation_method{PGM_default_method};
+        bool symmetric_calculation{static_cast<bool>(PGM_symmetric)};
+        double error_tolerance{1e-8};
+        Idx max_iterations{20};
+        Idx threading{-1};
+        Idx short_circuit_voltage_scaling{PGM_short_circuit_voltage_scaling_maximum};
+        Idx tap_changing_strategy{PGM_tap_changing_strategy_disabled};
+        bool use_msgpack_output_serialization{false};
+        Idx output_json_indent{2};
+        bool use_compact_serialization{false};
+        std::string output_dataset_name;
+        MetaDataset const* output_dataset{nullptr};
+        std::map<MetaComponent const*, std::set<MetaAttribute const*>> output_component_attribute_filters;
+        bool verbose{false};
+        friend std::ostream& operator<<(std::ostream& os, ClIOptions const& options);
+    };
+    CLIResult parse_cli_options(int argc, char** argv, ClIOptions& options);
+    void pgm_calculation(ClIOptions const& cli_options);
+    } // namespace power_grid_model_cpp

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Experimental] PGM CLI implementation #1297

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

[Experimental] PGM CLI implementation #1297

Are you sure you want to change the base?

[Experimental] PGM CLI implementation #1297

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!