Modeler 2.5a: Read models and system yaml files [ANT-2306]

src/solver/modeler/CMakeLists.txt

@@ -1,2 +1,3 @@
 add_subdirectory(api)
 add_subdirectory(ortoolsImpl)
+add_subdirectory(loadFiles)

src/solver/modeler/loadFiles/CMakeLists.txt

@@ -0,0 +1,31 @@
+set(SOURCES
+        readSystem.cpp
+        readLibraries.cpp
+
+        include/antares/solver/modeler/loadFiles/loadFiles.h
+)
+
+# Create the library
+add_library(loadModelerFiles STATIC ${SOURCES})
+add_library(Antares::loadModelerFiles ALIAS loadModelerFiles)
+
+# Specify include directories
+target_include_directories(loadModelerFiles
+        PUBLIC
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+)
+
+# Link dependencies (if any)
+target_link_libraries(loadModelerFiles
+        PUBLIC
+        Antares::antares-study-system-model
+        PRIVATE
+        io
+        Antares::systemParser
+        Antares::modelParser
+        Antares::modelConverter
+)
+
+install(DIRECTORY include/antares
+        DESTINATION "include"
+)

src/solver/modeler/loadFiles/include/antares/solver/modeler/loadFiles/loadFiles.h

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2007-2024, RTE (https://www.rte-france.com)
+ * See AUTHORS.txt
+ * SPDX-License-Identifier: MPL-2.0
+ * This file is part of Antares-Simulator,
+ * Adequacy and Performance assessment for interconnected energy networks.
+ *
+ * Antares_Simulator is free software: you can redistribute it and/or modify
+ * it under the terms of the Mozilla Public Licence 2.0 as published by
+ * the Mozilla Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Antares_Simulator is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * Mozilla Public Licence 2.0 for more details.
+ *
+ * You should have received a copy of the Mozilla Public Licence 2.0
+ * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
+ */
+
+#pragma once
+
+#include <filesystem>
+
+#include <antares/study/system-model/library.h>
+#include <antares/study/system-model/system.h>
+
+namespace Antares::Solver::LoadFiles
+{
+
+Study::SystemModel::System loadSystem(const std::filesystem::path& studyPath,
+                                      const std::vector<Study::SystemModel::Library>& libraries);
+
+} // namespace Antares::Solver::LoadFiles

src/solver/modeler/loadFiles/readLibraries.cpp

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2007-2024, RTE (https://www.rte-france.com)
+ * See AUTHORS.txt
+ * SPDX-License-Identifier: MPL-2.0
+ * This file is part of Antares-Simulator,
+ * Adequacy and Performance assessment for interconnected energy networks.
+ *
+ * Antares_Simulator is free software: you can redistribute it and/or modify
+ * it under the terms of the Mozilla Public Licence 2.0 as published by
+ * the Mozilla Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Antares_Simulator is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * Mozilla Public Licence 2.0 for more details.
+ *
+ * You should have received a copy of the Mozilla Public Licence 2.0
+ * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
+ */
+
+#include <antares/io/file.h>
+#include <antares/logs/logs.h>
+#include <antares/solver/modelConverter/modelConverter.h>
+#include <antares/solver/modelParser/parser.h>
+#include "antares/solver/modeler/loadFiles/loadFiles.h"
+
+namespace fs = std::filesystem;
+
+namespace Antares::Solver::LoadFiles
+{
+
+static Study::SystemModel::Library loadSingleLibrary(const fs::path& filePath)
+{
+    const std::string libraryStr = IO::readFile(filePath);
+
+    ModelParser::Parser parser;
+    ModelParser::Library libraryObj = parser.parse(libraryStr);
+    return ModelConverter::convert(libraryObj);
+}
+
+std::vector<Study::SystemModel::Library> loadLibraries(const fs::path& studyPath)
+{
+    std::vector<Study::SystemModel::Library> libraries;
+
+    const fs::path directoryPath = studyPath / "input" / "model-libraries";
+    for (const auto& entry: fs::directory_iterator(directoryPath))
+    {
+        if (entry.path().extension() != "yml")
+        {
+            logs.info() << "File ignored because of wrong extension: " << entry.path();
+            continue;
+        }
+
+        libraries.push_back(loadSingleLibrary(entry.path()));
+    }
+
+    return libraries;
+}
+} // namespace Antares::Solver::LoadFiles

src/solver/modeler/loadFiles/readSystem.cpp

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2007-2024, RTE (https://www.rte-france.com)
+ * See AUTHORS.txt
+ * SPDX-License-Identifier: MPL-2.0
+ * This file is part of Antares-Simulator,
+ * Adequacy and Performance assessment for interconnected energy networks.
+ *
+ * Antares_Simulator is free software: you can redistribute it and/or modify
+ * it under the terms of the Mozilla Public Licence 2.0 as published by
+ * the Mozilla Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Antares_Simulator is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * Mozilla Public Licence 2.0 for more details.
+ *
+ * You should have received a copy of the Mozilla Public Licence 2.0
+ * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
+ */
+
+#include <antares/io/file.h>
+#include <antares/solver/systemParser/converter.h>
+#include <antares/solver/systemParser/parser.h>
+#include "antares/solver/modeler/loadFiles/loadFiles.h"
+
+namespace fs = std::filesystem;
+
+namespace Antares::Solver::LoadFiles
+{
+
+Study::SystemModel::System loadSystem(const fs::path& studyPath,
+                                      const std::vector<Study::SystemModel::Library>& libraries)
+{
+    const std::string systemStr = IO::readFile(studyPath / "input" / "system.yml");
+
+    SystemParser::Parser parser;
+    SystemParser::System systemObj = parser.parse(systemStr);
+
+    return SystemConverter::convert(systemObj, libraries);
+}
+
+} // namespace Antares::Solver::LoadFiles

src/tests/src/solver/modeler/CMakeLists.txt

@@ -1 +1,2 @@
 add_subdirectory(api)
+add_subdirectory(loadFiles)

src/tests/src/solver/modeler/loadFiles/CMakeLists.txt

@@ -0,0 +1,14 @@
+add_executable(load-modeler-files
+               testLoadModelerFiles.cpp)
+
+target_link_libraries(load-modeler-files
+        PRIVATE
+        Boost::unit_test_framework
+        Antares::loadModelerFiles
+        test_utils_unit
+)
+
+set_target_properties(load-modeler-files PROPERTIES FOLDER Unit-tests/test-writer)
+
+add_test(NAME load-modeler-files COMMAND load-modeler-files)
+set_tests_properties(load-modeler-files PROPERTIES LABELS unit)

src/tests/src/solver/modeler/loadFiles/testLoadModelerFiles.cpp

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2007-2024, RTE (https://www.rte-france.com)
+ * See AUTHORS.txt
+ * SPDX-License-Identifier: MPL-2.0
+ * This file is part of Antares-Simulator,
+ * Adequacy and Performance assessment for interconnected energy networks.
+ *
+ * Antares_Simulator is free software: you can redistribute it and/or modify
+ * it under the terms of the Mozilla Public Licence 2.0 as published by
+ * the Mozilla Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Antares_Simulator is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * Mozilla Public Licence 2.0 for more details.
+ *
+ * You should have received a copy of the Mozilla Public Licence 2.0
+ * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
+ */
+#define WIN32_LEAN_AND_MEAN
+
+#include <fstream>
+#define BOOST_TEST_MODULE load modeler files
+
+#include <boost/test/unit_test.hpp>
+
+#include <antares/solver/modeler/loadFiles/loadFiles.h>
+
+#include "files-system.h"
+
+BOOST_AUTO_TEST_SUITE(read_modeler_parameters)
+
+BOOST_AUTO_TEST_CASE(all_properties_set)
+{
+    /* const auto working_tmp_dir = CREATE_TMP_DIR_BASED_ON_TEST_NAME(); */
+    /* const auto fileP = working_tmp_dir / "parameters.yaml"; */
+    /* { */
+    /*     std::ofstream param(fileP); */
+    /*     param << R"( */
+    /* solver: sirius */
+    /* solver-logs: false */
+    /* solver-parameters: PRESOLVE 1 */
+    /* no-output: true)"; */
+    /* } */
+
+    /* auto params = Antares::Solver::parseModelerParameters(fileP); */
+    /* BOOST_CHECK_EQUAL(params.solver, "sirius"); */
+    /* BOOST_CHECK_EQUAL(params.solverLogs, false); */
+    /* BOOST_CHECK_EQUAL(params.solverParameters, "PRESOLVE 1"); */
+    /* BOOST_CHECK_EQUAL(params.noOutput, true); */
+}
+
+BOOST_AUTO_TEST_SUITE_END()