rtc-tools 2.7.0a4__tar.gz → 2.7.0b2__tar.gz

{rtc_tools-2.7.0a4/src/rtc_tools.egg-info → rtc_tools-2.7.0b2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: rtc-tools
-Version: 2.7.0a4
+Version: 2.7.0b2
 Summary: Toolbox for control and optimization of water systems.
 Home-page: https://oss.deltares.nl/web/rtc-tools/home
 Download-URL: http://github.com/deltares/rtc-tools/
@@ -25,7 +25,7 @@ Classifier: Operating System :: Unix
 Classifier: Operating System :: MacOS
 Requires-Python: >=3.9
 License-File: COPYING.LESSER
-Requires-Dist: casadi!=3.6.6,==3.6.*,>=3.6.3
+Requires-Dist: casadi!=3.6.6,<=3.7,>=3.6.3
 Requires-Dist: numpy>=1.16.0
 Requires-Dist: scipy>=1.0.0
 Requires-Dist: pymoca==0.9.*,>=0.9.1
@@ -41,6 +41,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: download-url
 Dynamic: home-page
+Dynamic: license-file
 Dynamic: maintainer
 Dynamic: platform
 Dynamic: provides-extra

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/pyproject.toml

@@ -8,15 +8,16 @@ exclude = '''
 '''
 
 [tool.ruff]
-ignore = [
+lint.ignore = [
 	"B904", # Fix someday: raising exceptions within except
 ]
 line-length = 100
-select = [
+lint.select = [
     "B", # flake8-bugbear
     "C4", # flake8-comprehensions
     "E", # default / pycodestyle
     "F", # default / pyflakes
     "I", # isort
     "W", # pycodestyle
+
 ]

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/setup.py

@@ -3,6 +3,7 @@
 RTC-Tools is the Deltares toolbox for control and optimization of water systems.
 
 """
+
 import sys
 
 from setuptools import find_packages, setup
@@ -44,7 +45,7 @@ setup(
     packages=find_packages("src"),
     package_dir={"": "src"},
     install_requires=[
-        "casadi >= 3.6.3, == 3.6.*, !=3.6.6",
+        "casadi >= 3.6.3, <= 3.7, !=3.6.6",
         "numpy >= 1.16.0",
         "scipy >= 1.0.0",
         "pymoca >= 0.9.1, == 0.9.*",

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2/src/rtc_tools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: rtc-tools
-Version: 2.7.0a4
+Version: 2.7.0b2
 Summary: Toolbox for control and optimization of water systems.
 Home-page: https://oss.deltares.nl/web/rtc-tools/home
 Download-URL: http://github.com/deltares/rtc-tools/
@@ -25,7 +25,7 @@ Classifier: Operating System :: Unix
 Classifier: Operating System :: MacOS
 Requires-Python: >=3.9
 License-File: COPYING.LESSER
-Requires-Dist: casadi!=3.6.6,==3.6.*,>=3.6.3
+Requires-Dist: casadi!=3.6.6,<=3.7,>=3.6.3
 Requires-Dist: numpy>=1.16.0
 Requires-Dist: scipy>=1.0.0
 Requires-Dist: pymoca==0.9.*,>=0.9.1
@@ -41,6 +41,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: download-url
 Dynamic: home-page
+Dynamic: license-file
 Dynamic: maintainer
 Dynamic: platform
 Dynamic: provides-extra

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtc_tools.egg-info/requires.txt

@@ -1,4 +1,4 @@
-casadi!=3.6.6,==3.6.*,>=3.6.3
+casadi!=3.6.6,<=3.7,>=3.6.3
 numpy>=1.16.0
 scipy>=1.0.0
 pymoca==0.9.*,>=0.9.1

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-03-04T13:14:14+0100",
+ "date": "2025-04-23T08:24:20+0200",
  "dirty": false,
  "error": null,
- "full-revisionid": "240ff5dd3c6cbe9ba51eef09e6bd750cd309a1bf",
- "version": "2.7.0a4"
+ "full-revisionid": "1c7b20a741febcb81ad1b0b00a5a5d4ece276e13",
+ "version": "2.7.0b2"
 }
 '''  # END VERSION_JSON
 

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/data/netcdf.py

@@ -401,20 +401,21 @@ class ExportDataset:
         """
         assert len(set(variable_names)) == len(variable_names)
 
-        assert (
-            self.__time_dim is not None
-        ), "First call write_times to ensure the time dimension has been created."
-        assert (
-            self.__station_dim is not None
-        ), "First call write_station_data to ensure the station dimension has been created"
+        assert self.__time_dim is not None, (
+            "First call write_times to ensure the time dimension has been created."
+        )
+        assert self.__station_dim is not None, (
+            "First call write_station_data to ensure the station dimension has been created"
+        )
         assert (
             self.__station_id_to_index_mapping is not None
         )  # should also be created in write_station_data
 
         if ensemble_size > 1:
-            assert (
-                self.__ensemble_member_dim is not None
-            ), "First call write_ensemble_data to ensure the realization dimension has been created"
+            assert self.__ensemble_member_dim is not None, (
+                "First call write_ensemble_data to ensure "
+                "the realization dimension has been created"
+            )
 
             for variable_name in variable_names:
                 self.__dataset.createVariable(
@@ -446,15 +447,15 @@ class ExportDataset:
         :param values:        The values that are to be written to the file
         :param ensemble_size: the number of members in the ensemble
         """
-        assert (
-            self.__station_id_to_index_mapping is not None
-        ), "First call write_station_data and create_variables."
+        assert self.__station_id_to_index_mapping is not None, (
+            "First call write_station_data and create_variables."
+        )
 
         station_index = self.__station_id_to_index_mapping[station_id]
         if ensemble_size > 1:
-            self.__dataset.variables[variable_name][
-                :, station_index, ensemble_member_index
-            ] = values
+            self.__dataset.variables[variable_name][:, station_index, ensemble_member_index] = (
+                values
+            )
         else:
             self.__dataset.variables[variable_name][:, station_index] = values
 

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/data/pi.py

@@ -333,8 +333,11 @@ class ParameterConfig:
 
             parameters = group.findall("pi:parameter", ns)
             for parameter in parameters:
-                yield location_id, model_id, parameter.attrib["id"], self.__parse_parameter(
-                    parameter
+                yield (
+                    location_id,
+                    model_id,
+                    parameter.attrib["id"],
+                    self.__parse_parameter(parameter),
                 )
 
 

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/data/rtc.py

@@ -60,9 +60,9 @@ class DataConfig:
                         logger.error(message)
                         raise Exception(message)
                     else:
-                        self.__location_parameter_ids[
-                            internal_id
-                        ] = self.__pi_location_parameter_id(pi_timeseries, "fews")
+                        self.__location_parameter_ids[internal_id] = (
+                            self.__pi_location_parameter_id(pi_timeseries, "fews")
+                        )
                         self.__variable_map[external_id] = internal_id
 
             for k in ["import", "export"]:

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/optimization/collocated_integrated_optimization_problem.py

@@ -1028,8 +1028,8 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
             + len(self.dae_variables["constant_inputs"])
         ]
         constant_inputs_1 = accumulated_U[
-            2 * len(collocated_variables)
-            + len(self.dae_variables["constant_inputs"]) : 2 * len(collocated_variables)
+            2 * len(collocated_variables) + len(self.dae_variables["constant_inputs"]) : 2
+            * len(collocated_variables)
             + 2 * len(self.dae_variables["constant_inputs"])
         ]
 
@@ -1803,9 +1803,9 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
                     # Cast delay from DM to np.array
                     delay = delay.toarray().flatten()
 
-                    assert np.all(
-                        np.isfinite(delay)
-                    ), "Delay duration must be resolvable to real values at transcribe()"
+                    assert np.all(np.isfinite(delay)), (
+                        "Delay duration must be resolvable to real values at transcribe()"
+                    )
 
                     out_times = np.concatenate([history_times, collocation_times])
                     out_values = ca.veccat(
@@ -2043,9 +2043,7 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
     def controls(self):
         return self.__controls
 
-    def _collint_get_lbx_ubx(self, count, indices):
-        bounds = self.bounds()
-
+    def _collint_get_lbx_ubx(self, bounds, count, indices):
         lbx = np.full(count, -np.inf, dtype=np.float64)
         ubx = np.full(count, np.inf, dtype=np.float64)
 
@@ -2210,7 +2208,7 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
                 count = max(count, control_indices_stop)
 
         discrete = self._collint_get_discrete(count, indices)
-        lbx, ubx = self._collint_get_lbx_ubx(count, indices)
+        lbx, ubx = self._collint_get_lbx_ubx(bounds, count, indices)
         x0 = self._collint_get_x0(count, indices)
 
         # Return number of control variables
@@ -2326,7 +2324,7 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
                 offset += 1
 
         discrete = self._collint_get_discrete(count, indices)
-        lbx, ubx = self._collint_get_lbx_ubx(count, indices)
+        lbx, ubx = self._collint_get_lbx_ubx(bounds, count, indices)
         x0 = self._collint_get_x0(count, indices)
 
         # Return number of state variables
@@ -2869,8 +2867,7 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
 
         # Check coefficient matrix
         logger.info(
-            "Sanity check on objective and constraints Jacobian matrix"
-            "/constant coefficients values"
+            "Sanity check on objective and constraints Jacobian matrix/constant coefficients values"
         )
 
         in_var = nlp["x"]
@@ -3113,7 +3110,7 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
         variable_to_all_indices = {k: set(v) for k, v in indices[0].items()}
         for ensemble_indices in indices[1:]:
             for k, v in ensemble_indices.items():
-                variable_to_all_indices[k] |= v
+                variable_to_all_indices[k] |= set(v)
 
         if len(inds_up) > 0:
             exceedences = []

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/optimization/control_tree_mixin.py

@@ -86,6 +86,11 @@ class ControlTreeMixin(OptimizationProblem):
         logger.debug("ControlTreeMixin: Branching times:")
         logger.debug(self.__branching_times)
 
+        # Avoid calling constant_inputs() many times
+        constant_inputs = [
+            self.constant_inputs(ensemble_member=i) for i in range(self.ensemble_size)
+        ]
+
         # Branches start at branching times, so that the tree looks like the following:
         #
         #         *-----
@@ -122,18 +127,16 @@ class ControlTreeMixin(OptimizationProblem):
             for forecast_variable in options["forecast_variables"]:
                 # We assume the time stamps of the forecasts in all ensemble
                 # members to be identical
-                timeseries = self.constant_inputs(ensemble_member=0)[forecast_variable]
+                timeseries = constant_inputs[0][forecast_variable]
                 els = np.logical_and(
                     timeseries.times >= branching_time_0, timeseries.times < branching_time_1
                 )
 
                 # Compute distance between ensemble members
                 for i, member_i in enumerate(branches[current_branch]):
-                    timeseries_i = self.constant_inputs(ensemble_member=member_i)[forecast_variable]
+                    timeseries_i = constant_inputs[member_i][forecast_variable]
                     for j, member_j in enumerate(branches[current_branch]):
-                        timeseries_j = self.constant_inputs(ensemble_member=member_j)[
-                            forecast_variable
-                        ]
+                        timeseries_j = constant_inputs[member_j][forecast_variable]
                         distances[i, j] += np.linalg.norm(
                             timeseries_i.values[els] - timeseries_j.values[els]
                         )

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/optimization/csv_lookup_table_mixin.py

@@ -55,7 +55,7 @@ class LookupTable(LookupTableBase):
                 "This lookup table was not instantiated with tck metadata. \
                                   Domain/Range information is unavailable."
             )
-        if type(t) == tuple and len(t) == 2:
+        if isinstance(t, tuple) and len(t) == 2:
             raise NotImplementedError(
                 "Domain/Range information is not yet implemented for 2D LookupTables"
             )
@@ -298,8 +298,9 @@ class CSVLookupTableMixin(OptimizationProblem):
         def check_lookup_table(lookup_table):
             if lookup_table in self.__lookup_tables:
                 raise Exception(
-                    "Cannot add lookup table {},"
-                    "since there is already one with this name.".format(lookup_table)
+                    "Cannot add lookup table {},since there is already one with this name.".format(
+                        lookup_table
+                    )
                 )
 
         # Read CSV files
@@ -358,6 +359,7 @@ class CSVLookupTableMixin(OptimizationProblem):
                             k=k,
                             monotonicity=mono,
                             curvature=curv,
+                            ipopt_options={"nlp_scaling_method": "none"},
                         )
                     else:
                         raise Exception(

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/optimization/goal_programming_mixin.py

@@ -351,8 +351,9 @@ class GoalProgrammingMixin(_GoalProgrammingMixinBase):
         if goal.has_target_bounds:
             # We use a violation variable formulation, with the violation
             # variables epsilon bounded between 0 and 1.
-            m, M = np.full_like(epsilon, -np.inf, dtype=np.float64), np.full_like(
-                epsilon, np.inf, dtype=np.float64
+            m, M = (
+                np.full_like(epsilon, -np.inf, dtype=np.float64),
+                np.full_like(epsilon, np.inf, dtype=np.float64),
             )
 
             # A function range does not have to be specified for critical

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/optimization/goal_programming_mixin_base.py

@@ -437,7 +437,7 @@ class _GoalConstraint:
     ):
         assert isinstance(m, (float, np.ndarray, Timeseries))
         assert isinstance(M, (float, np.ndarray, Timeseries))
-        assert type(m) == type(M)
+        assert type(m) is type(M)
 
         # NumPy arrays only allowed for vector goals
         if isinstance(m, np.ndarray):
@@ -982,8 +982,9 @@ class _GoalProgrammingMixinBase(OptimizationProblem, metaclass=ABCMeta):
         if goal.has_target_bounds:
             # We use a violation variable formulation, with the violation
             # variables epsilon bounded between 0 and 1.
-            m, M = np.full_like(epsilon, -np.inf, dtype=np.float64), np.full_like(
-                epsilon, np.inf, dtype=np.float64
+            m, M = (
+                np.full_like(epsilon, -np.inf, dtype=np.float64),
+                np.full_like(epsilon, np.inf, dtype=np.float64),
             )
 
             # A function range does not have to be specified for critical

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/optimization/modelica_mixin.py

@@ -334,7 +334,7 @@ class ModelicaMixin(OptimizationProblem):
             try:
                 (m, M) = bounds[sym_name]
             except KeyError:
-                if self.__python_types.get(sym_name, float) == bool:
+                if self.__python_types.get(sym_name, float) is bool:
                     (m, M) = (0, 1)
                 else:
                     (m, M) = (-np.inf, np.inf)
@@ -408,7 +408,7 @@ class ModelicaMixin(OptimizationProblem):
         return seed
 
     def variable_is_discrete(self, variable):
-        return self.__python_types.get(variable, float) != float
+        return self.__python_types.get(variable, float) is not float
 
     @property
     @cached

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/optimization/optimization_problem.py

@@ -314,6 +314,24 @@ class OptimizationProblem(DataStoreAccessor, metaclass=ABCMeta):
         if log_level == logging.ERROR and not log_solver_failure_as_error:
             log_level = logging.INFO
 
+        if self.solver_options()["solver"].lower() == "knitro":
+            list_feas_flags = [
+                "KN_RC_OPTIMAL_OR_SATISFACTORY",
+                "KN_RC_ITER_LIMIT_FEAS",
+                "KN_RC_NEAR_OPT",
+                "KN_RC_FEAS_XTOL",
+                "KN_RC_FEAS_NO_IMPROVE",
+                "KN_RC_FEAS_FTOL",
+                "KN_RC_TIME_LIMIT_FEAS",
+                "KN_RC_FEVAL_LIMIT_FEAS",
+                "KN_RC_MIP_EXH_FEAS",
+                "KN_RC_MIP_TERM_FEAS",
+                "KN_RC_MIP_SOLVE_LIMIT_FEAS",
+                "KN_RC_MIP_NODE_LIMIT_FEAS",
+            ]
+            if solver_stats["return_status"] in list_feas_flags:
+                success = True
+
         return success, log_level
 
     @abstractproperty

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/optimization/pi_mixin.py

@@ -285,8 +285,8 @@ class PIMixin(IOMixin):
         :param variable:        Time series ID.
         :param unit:            Unit.
         """
-        assert hasattr(
-            self, "_PIMixin__timeseries_import"
-        ), "set_unit can only be called after read() in pre() has finished."
+        assert hasattr(self, "_PIMixin__timeseries_import"), (
+            "set_unit can only be called after read() in pre() has finished."
+        )
         self.__timeseries_import.set_unit(variable, unit, 0)
         self.__timeseries_export.set_unit(variable, unit, 0)

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/simulation/io_mixin.py

@@ -94,7 +94,7 @@ class IOMixin(SimulationProblem, metaclass=ABCMeta):
             self.__cache_loop_timeseries = {}
 
             timeseries_names = set(self.io.get_timeseries_names(0))
-            for v in self.get_variables():
+            for v in self.get_input_variables():
                 if v in timeseries_names:
                     _, values = self.io.get_timeseries_sec(v)
                     self.__cache_loop_timeseries[v] = values

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/simulation/pi_mixin.py

@@ -248,8 +248,8 @@ class PIMixin(IOMixin):
         :param variable:        Time series ID.
         :param unit:            Unit.
         """
-        assert hasattr(
-            self, "_PIMixin__timeseries_import"
-        ), "set_unit can only be called after read() in pre() has finished."
+        assert hasattr(self, "_PIMixin__timeseries_import"), (
+            "set_unit can only be called after read() in pre() has finished."
+        )
         self.__timeseries_import.set_unit(variable, unit, 0)
         self.__timeseries_export.set_unit(variable, unit, 0)

{rtc_tools-2.7.0a4 → rtc_tools-2.7.0b2}/src/rtctools/simulation/simulation_problem.py

@@ -500,8 +500,9 @@ class SimulationProblem(DataStoreAccessor):
                 self.set_var(var_name, numeric_start_val)
             except KeyError:
                 logger.warning(
-                    "Initialize: {} not found in state vector. "
-                    "Initial value of {} not set.".format(var_name, numeric_start_val)
+                    "Initialize: {} not found in state vector. Initial value of {} not set.".format(
+                        var_name, numeric_start_val
+                    )
                 )
 
             # Add a residual for the difference between the state and its starting expression
@@ -525,10 +526,14 @@ class SimulationProblem(DataStoreAccessor):
             # Check that the start_value is in between the variable bounds.
             if start_is_numeric and not min_is_symbolic and not max_is_symbolic:
                 if not (var.min <= start_val and start_val <= var.max):
-                    logger.warning(
-                        "Initialize: start value {} = {}".format(var_name, start_val)
-                        + " is not in between bounds {} and {}".format(var.min, var.max)
-                        + " and will be adjusted."
+                    logger.log(
+                        (
+                            logging.WARNING
+                            if source_description != "modelica file or default value"
+                            else logging.DEBUG
+                        ),
+                        f"Initialize: start value {var_name} = {start_val} "
+                        f"is not in between bounds {var.min} and {var.max} and will be adjusted.",
                     )
 
         # Default start var for ders is zero
@@ -1067,9 +1072,9 @@ class SimulationProblem(DataStoreAccessor):
         :param dt: Timestep size of the simulation.
         """
         if self._dt_is_fixed:
-            assert math.isclose(
-                self.__dt, dt
-            ), "Timestep size dt is marked as constant and cannot be changed."
+            assert math.isclose(self.__dt, dt), (
+                "Timestep size dt is marked as constant and cannot be changed."
+            )
         else:
             self.__dt = dt