Merge branch release/8.8.x into develop (changelog, version number)

.github/workflows/ubuntu.yml

@@ -162,6 +162,15 @@ jobs:
         batch-name: valid-v830
         os: ${{ matrix.test-platform }}
 
+    - name: Run MILP with CBC
+      if: ${{ env.IS_PUSH == 'true' }}
+      uses: ./.github/workflows/run-tests
+      with:
+        simtest-tag: ${{steps.simtest-version.outputs.prop}}
+        batch-name: valid-milp
+        variant: "milp-cbc"
+        os: ${{ matrix.test-platform }}
+
     - name: Run tests introduced in v860
       if: ${{ env.IS_PUSH == 'true' }}
       uses: ./.github/workflows/run-tests

.github/workflows/windows-vcpkg.yml

@@ -196,6 +196,15 @@ jobs:
         batch-name: valid-v830
         os: ${{ matrix.test-platform }}
 
+    - name: Run MILP with CBC
+      if: ${{ env.IS_PUSH == 'true' }}
+      uses: ./.github/workflows/run-tests
+      with:
+        simtest-tag: ${{steps.simtest-version.outputs.prop}}
+        batch-name: valid-milp
+        variant: "milp-cbc"
+        os: ${{ matrix.test-platform }}
+
     - name: Run tests introduced in v860
       uses: ./.github/workflows/run-tests
       with:

docs/CHANGELOG.md

@@ -6,32 +6,13 @@ Antares Changelog
 ## New Features
 * Solver logs can be enabled either by the command-line option (--solver-logs) or in the generaldata.ini by setting solver-logs = true under the optimization section [(#1717)](https://github.com/AntaresSimulatorTeam/Antares_Simulator/pull/1717)
 
-
-8.8.0-rc3 (11/2023)
---------------------
-## Bugfixes
-* Fix oracle-linux8 binaries missing compression feature (#1741)
-
-8.8.0-rc2 (10/2023)
+8.8.0 (12/2023)
 --------------------
-## Build
-- Fix version numbers (8b9b2b389)
 
-8.8.0-rc1 (10/2023)
---------------------
 ## New features
 * New "cash-flow" variable for ST storage (#1633)
-* Experimental ptimization discrete variables (#670)
-
-## Bugfixes
-* Prevent segfault during simulation, check bounds of scenario builder (#1567)
-* Fix number of links in deprecated output file digest.txt (#1646)
-* Fix unfeasible problem analyzer (#1527)
-* [Windows only] Increase file size limit when reading file (#1674)
-* Fix segfault encountered when importing logs (#1702)
-* Fixes swallowed exceptions in computation thread (#1685)
-* Fix writer causing a segfault with OR-Tools (#1584)
-* Bug on renewable cluster (wrong group) (#1631)
+* Experimental optimization with discrete variables (MILP unit-commitment mode, #670)
+* Add `enabled` property for ST storage objects, fix bug related to saving ST objects (#1807)
 
 ## Improvements
 * Add shortcut -s for names MPS problems in CLI options (#1613)
@@ -41,8 +22,26 @@ Antares Changelog
 * Fix wrong year number in logs upon failed year (#1672)
 * Always check mingen against maxPower, regardless of reservoirManagement (#1656)
 * New log msg when solver not found in or-tools (#1687)
+
+## For developers
 * Fix annoying error log about correlation matrices in tests (#1573)
 
+## Bugfixes (reported by users)
+* Fix output variable PROFIT for thermal clusters (#1767)
+* Bug on renewable cluster (wrong group) (#1631)
+
+## Bugfixes (reported internally)
+* Fix oracle-linux8 binaries missing compression feature (#1741)
+* Named MPS - fix duplicated "ranged" binding constraints (#1569)
+* Fix save for short term storage objects (#1807)
+* Prevent segfault during simulation, check bounds of scenario builder (#1567)
+* Fix number of links in deprecated output file digest.txt (#1646)
+* Fix unfeasible problem analyzer (#1527)
+* [Windows only] Increase file size limit when reading file (#1674)
+* Fix segfault encountered when importing logs (#1702)
+* Fixes swallowed exceptions in computation thread (#1685)
+* Fix writer causing a segfault with OR-Tools (#1584)
+
 ## Documentation
 * Create Doxygen documentation (#1650)
 * Update README.md (#1654)

simtest.json

@@ -1,3 +1,3 @@
 {
-    "version": "v8.7.2"
+    "version": "v8.8.0-rc1"
 }

src/CMakeLists.txt

@@ -7,7 +7,7 @@ set(ANTARES_VERSION_REVISION  0)
 
 # Beta release
 set(ANTARES_BETA 0)
-set(ANTARES_RC 3)
+set(ANTARES_RC 0)
 
 set(ANTARES_VERSION_YEAR      2023)
 

src/libs/antares/study/parts/short-term-storage/cluster.cpp

@@ -63,8 +63,16 @@ bool STStorageCluster::loadFromSection(const IniFile::Section& section)
     return true;
 }
 
+bool STStorageCluster::enabled() const
+{
+    return properties.enabled;
+}
+
 bool STStorageCluster::validate() const
 {
+    if (!enabled())
+        return true;
+
     logs.debug() << "Validating properties and series for st storage: " << id;
     return properties.validate() && series->validate();
 }
@@ -76,9 +84,9 @@ bool STStorageCluster::loadSeries(const std::string& folder) const
     return ret;
 }
 
-bool STStorageCluster::saveProperties(const std::string& path) const
+void STStorageCluster::saveProperties(IniFile& ini) const
 {
-    return properties.saveToFolder(path);
+    properties.save(ini);
 }
 
 bool STStorageCluster::saveSeries(const std::string& path) const

src/libs/antares/study/parts/short-term-storage/cluster.h

@@ -37,12 +37,13 @@ namespace Antares::Data::ShortTermStorage
 class STStorageCluster
 {
 public:
+    bool enabled() const;
     bool validate() const;
-    bool loadFromSection(const IniFile::Section& section);
 
+    bool loadFromSection(const IniFile::Section& section);
     bool loadSeries(const std::string& folder) const;
 
-    bool saveProperties(const std::string& path) const;
+    void saveProperties(IniFile& ini) const;
     bool saveSeries(const std::string& path) const;
 
     std::string id;

src/libs/antares/study/parts/short-term-storage/container.cpp

@@ -92,12 +92,16 @@ bool STStorageInput::saveToFolder(const std::string& folder) const
 {
     // create empty list.ini if there's no sts in this area
     Yuni::IO::Directory::Create(folder);
-    Yuni::IO::File::CreateEmptyFile(folder + SEP + "list.ini");
-    logs.notice() << "created empty ini: " << folder + SEP + "list.ini";
+    const std::string pathIni(folder + SEP + "list.ini");
+    IniFile ini;
 
-    return std::all_of(storagesByIndex.cbegin(), storagesByIndex.cend(), [&folder](auto& storage) {
-        return storage.saveProperties(folder);
+    logs.debug() << "saving file " << pathIni;
+
+    std::for_each(storagesByIndex.cbegin(), storagesByIndex.cend(), [&ini](auto& storage) {
+        return storage.saveProperties(ini);
     });
+
+    return ini.save(pathIni);
 }
 
 bool STStorageInput::saveDataSeriesToFolder(const std::string& folder) const
@@ -110,6 +114,22 @@ bool STStorageInput::saveDataSeriesToFolder(const std::string& folder) const
 
 std::size_t STStorageInput::count() const
 {
-    return storagesByIndex.size();
+  return std::count_if(storagesByIndex.begin(),
+                       storagesByIndex.end(),
+                       [](const STStorageCluster& st) {
+                           return st.properties.enabled;
+                       });
+}
+
+uint STStorageInput::removeDisabledClusters()
+{
+    const auto& it = std::remove_if(storagesByIndex.begin(), storagesByIndex.end(),
+        [](const auto& c) { return !c.enabled(); });
+
+    uint disabledCount = std::distance(it, storagesByIndex.end());
+    storagesByIndex.erase(it, storagesByIndex.end());
+
+    return disabledCount;
 }
+
 } // namespace Antares::Data::ShortTermStorage

src/libs/antares/study/parts/short-term-storage/container.h

@@ -36,12 +36,15 @@ class STStorageInput
 {
 public:
     bool validate() const;
-    // 1. Read list.ini
+    /// 1. Read list.ini
     bool createSTStorageClustersFromIniFile(const std::string& path);
-    // 2. Read ALL series
+    /// 2. Read ALL series
     bool loadSeriesFromFolder(const std::string& folder) const;
-    // Number of ST storages
+    /// Number of enabled ST storages, ignoring disabled ST storages
     std::size_t count() const;
+    /// erase disabled cluster from the vector
+    uint removeDisabledClusters();
+
 
     bool saveToFolder(const std::string& folder) const;
     bool saveDataSeriesToFolder(const std::string& folder) const;

src/libs/antares/study/parts/short-term-storage/properties.cpp

@@ -115,23 +115,14 @@ bool Properties::loadKey(const IniFile::Property* p)
         return false;
     }
 
+    if (p->key == "enabled")
+       return p->value.to<bool>(this->enabled);
+
     return false;
 }
 
-bool Properties::saveToFolder(const std::string& folder) const
+void Properties::save(IniFile& ini) const
 {
-    const std::string pathIni(folder + SEP + "list.ini");
-
-    // Make sure the folder is created
-    if (!Yuni::IO::Directory::Create(folder))
-    {
-        logs.warning() << "Couldn't create dir for sts: " << folder;
-        return false;
-    }
-
-    logs.debug() << "saving file " << pathIni;
-
-    IniFile ini;
     IniFile::Section* s = ini.addSection(this->name);
 
     s->add("name", this->name);
@@ -147,9 +138,7 @@ bool Properties::saveToFolder(const std::string& folder) const
 
     s->add("efficiency", this->efficiencyFactor);
     s->add("initialleveloptim", this->initialLevelOptim);
-
-
-    return ini.save(pathIni);
+    s->add("enabled", this->enabled);
 }
 
 bool Properties::validate()

src/libs/antares/study/parts/short-term-storage/properties.h

@@ -54,25 +54,28 @@ class Properties
 public:
     bool validate();
     bool loadKey(const IniFile::Property* p);
-    bool saveToFolder(const std::string& folder) const;
+    void save(IniFile& ini) const;
 
-    // Not optional   Injection nominal capacity, >= 0
+    /// Not optional   Injection nominal capacity, >= 0
     std::optional<double> injectionNominalCapacity;
-    // Not optional   Withdrawal nominal capacity, >= 0
+    /// Not optional   Withdrawal nominal capacity, >= 0
     std::optional<double> withdrawalNominalCapacity;
-    // Not optional   Reservoir capacity in MWh, >= 0
+    /// Not optional   Reservoir capacity in MWh, >= 0
     std::optional<double> reservoirCapacity;
-    // Initial level, <= 1
+    /// Initial level, <= 1
     double initialLevel = initiallevelDefault;
-    // Bool to optimise or not initial level
+    /// Bool to optimise or not initial level
     bool initialLevelOptim = false;
-    // Efficiency factor between 0 and 1
+    /// Efficiency factor between 0 and 1
     double efficiencyFactor = 1;
-    // Used to sort outputs
+    /// Used to sort outputs
     Group group = Group::Other1;
-    // cluster name
+    /// cluster name
     std::string name;
 
+    /// Enabled ?
+    bool enabled = true;
+
     static const std::map<std::string, enum Group> ST_STORAGE_PROPERTY_GROUP_ENUM;
 private:
     static constexpr double initiallevelDefault = .5;

src/libs/antares/study/runtime/runtime.cpp

@@ -293,6 +293,9 @@ bool StudyRuntimeInfos::loadFromStudy(Study& study)
     // Removing disabled thermal clusters from solver computations
     removeDisabledThermalClustersFromSolverComputations(study);
 
+    // Removing disabled short-term storage objects from solver computations
+    removeDisabledShortTermStorageClustersFromSolverComputations(study);
+
     switch (gd.renewableGeneration())
     {
     case rgClusters:
@@ -423,6 +426,13 @@ void StudyRuntimeInfos::removeDisabledRenewableClustersFromSolverComputations(St
     });
 }
 
+void StudyRuntimeInfos::removeDisabledShortTermStorageClustersFromSolverComputations(Study& study)
+{
+    removeClusters(
+      study, "short term storage", [](Area& area)
+      { return area.shortTermStorage.removeDisabledClusters(); });
+}
+
 void StudyRuntimeInfos::removeAllRenewableClustersFromSolverComputations(Study& study)
 {
     removeClusters(

src/libs/antares/study/runtime/runtime.h

@@ -138,6 +138,7 @@ class StudyRuntimeInfos
     void initializeThermalClustersInMustRunMode(Study& study) const;
     void removeDisabledThermalClustersFromSolverComputations(Study& study);
     void removeDisabledRenewableClustersFromSolverComputations(Study& study);
+    void removeDisabledShortTermStorageClustersFromSolverComputations(Study& study);
     void removeAllRenewableClustersFromSolverComputations(Study& study);
     void disableAllFilters(Study& study);
     void checkThermalTSGeneration(Study& study);

src/solver/variable/economy/STStorageCashFlowByCluster.h

@@ -278,14 +278,16 @@ class STstorageCashFlowByCluster : public Variable::IVariable<STstorageCashFlowB
             const auto& shortTermStorage = results.data.area->shortTermStorage;
 
             // Write the data for the current year
-            for (uint clusterIndex = 0; clusterIndex < nbClusters_; ++clusterIndex)
+            uint clusterIndex = 0;
+            for (const auto& cluster : shortTermStorage.storagesByIndex)
             {
                 // Write the data for the current year
-                const auto& cluster = shortTermStorage.storagesByIndex[clusterIndex];
                 results.variableCaption = cluster.properties.name;
                 results.variableUnit = VCardType::Unit();
                 pValuesForTheCurrentYear[numSpace][clusterIndex]
                   .template buildAnnualSurveyReport<VCardType>(results, fileLevel, precision);
+
+                clusterIndex++;
             }
         }
     }

src/solver/variable/economy/STStorageInjectionByCluster.h

@@ -280,14 +280,16 @@ class STstorageInjectionByCluster : public Variable::IVariable<STstorageInjectio
             const auto& shortTermStorage = results.data.area->shortTermStorage;
 
             // Write the data for the current year
-            for (uint clusterIndex = 0; clusterIndex < nbClusters_; ++clusterIndex)
+            uint clusterIndex = 0;
+            for (const auto& cluster : shortTermStorage.storagesByIndex)
             {
                 // Write the data for the current year
-                const auto& cluster = shortTermStorage.storagesByIndex[clusterIndex];
                 results.variableCaption = cluster.properties.name;
                 results.variableUnit = VCardType::Unit();
                 pValuesForTheCurrentYear[numSpace][clusterIndex]
                   .template buildAnnualSurveyReport<VCardType>(results, fileLevel, precision);
+
+                clusterIndex++;
             }
         }
     }

src/solver/variable/economy/STStorageLevelsByCluster.h

@@ -280,14 +280,16 @@ class STstorageLevelsByCluster
             const auto& shortTermStorage = results.data.area->shortTermStorage;
 
             // Write the data for the current year
-            for (uint clusterIndex = 0; clusterIndex < nbClusters_; ++clusterIndex)
+            uint clusterIndex = 0;
+            for (const auto& cluster : shortTermStorage.storagesByIndex)
             {
                 // Write the data for the current year
-                const auto& cluster = shortTermStorage.storagesByIndex[clusterIndex];
                 results.variableCaption = cluster.properties.name;
                 results.variableUnit = VCardType::Unit();
                 pValuesForTheCurrentYear[numSpace][clusterIndex].template buildAnnualSurveyReport<VCardType>(
                     results, fileLevel, precision);
+
+                clusterIndex++;
             }
         }
     }