rtc-tools 2.7.0.dev1__tar.gz → 2.7.1__tar.gz

{rtc_tools-2.7.0.dev1/src/rtc_tools.egg-info → rtc_tools-2.7.1}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: rtc-tools
-Version: 2.7.0.dev1
+Version: 2.7.1
 Summary: Toolbox for control and optimization of water systems.
 Home-page: https://oss.deltares.nl/web/rtc-tools/home
-Download-URL: http://gitlab.com/deltares/rtc-tools/
+Download-URL: http://github.com/deltares/rtc-tools/
 Author: Deltares
 Maintainer: Deltares
 Platform: Windows
@@ -25,12 +25,13 @@ 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
 Requires-Dist: rtc-tools-channel-flow>=1.2.0
 Requires-Dist: defusedxml>=0.7.0
+Requires-Dist: importlib_metadata>=5.0.0; python_version < "3.10"
 Provides-Extra: netcdf
 Requires-Dist: netCDF4; extra == "netcdf"
 Provides-Extra: all
@@ -40,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.0.dev1 → rtc_tools-2.7.1}/README.md

@@ -3,9 +3,9 @@
 [![Pipeline](https://github.com/deltares/rtc-tools/actions/workflows/rtc-tools.yml/badge.svg)](
     https://github.com/deltares/rtc-tools/actions/workflows/rtc-tools.yml
 )
-[![Coverage](https://codecov.io/gl/deltares/rtc-tools/branch/master/graph/badge.svg)](
-    https://codecov.io/gl/deltares/rtc-tools
-)
+[![Coverage](
+    https://sonarcloud.io/api/project_badges/measure?project=Deltares_rtc-tools&metric=coverage
+)](https://sonarcloud.io/summary/new_code?id=Deltares_rtc-tools)
 
 > **NOTE** The rtc-tools repository has been migrated from gitlab to here;
 see [migration from gitlab](#migration-from-gitlab).
@@ -46,12 +46,6 @@ RTC-Tools uses [CasADi](https://web.casadi.org/) as a symbolic framework for alg
 pip install rtc-tools
 ```
 
-When using Python 3.12 or higher, you might first need to install setuptools
-
-```bash
-pip install setuptools
-```
-
 ## Documentation
 
 Documentation and examples can be found on [readthedocs](https://rtc-tools.readthedocs.io).
@@ -71,8 +65,12 @@ and
 
 
 ## License
-RTC-Tools is licensed under the **[GNU Lesser General Public License v3.0](https://gitlab.com/deltares/rtc-tools/-/blob/guidelines_contributions/COPYING)**, and can be used free of charge. Deltares offers support packages for users who require assistance.
+RTC-Tools is licensed under the **[GNU Lesser General Public License v3.0](COPYING)**,
+and can be used free of charge. Deltares offers support packages for users who require assistance.
 
 
 ## Acknowledgment
-If you use RTC-Tools in your work, please acknowledge it in any resulting publications. You can do this by citing RTC-Tools and providing a link to our [website](https://oss.deltares.nl/web/rtc-tools/home) or [Gitlab repository](https://gitlab.com/deltares/rtc-tools).
+If you use RTC-Tools in your work, please acknowledge it in any resulting publications.
+You can do this by citing RTC-Tools and providing a link to our
+[website](https://oss.deltares.nl/web/rtc-tools/home) or
+[GitHub repository](https://github.com/deltares/rtc-tools).

{rtc_tools-2.7.0.dev1 → rtc_tools-2.7.1}/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.0.dev1 → rtc_tools-2.7.1}/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
@@ -38,18 +39,21 @@ setup(
     description=DOCLINES[0],
     long_description="\n".join(DOCLINES[2:]),
     url="https://oss.deltares.nl/web/rtc-tools/home",
-    download_url="http://gitlab.com/deltares/rtc-tools/",
+    download_url="http://github.com/deltares/rtc-tools/",
     classifiers=[_f for _f in CLASSIFIERS.split("\n") if _f],
     platforms=["Windows", "Linux", "Mac OS-X", "Unix"],
     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-channel-flow >= 1.2.0",
         "defusedxml >= 0.7.0",
+        # Python 3.9's importlib.metadata does not support the "group" parameter
+        # to entry_points yet.
+        "importlib_metadata >= 5.0.0; python_version < '3.10'",
     ],
     tests_require=["pytest", "pytest-runner", "netCDF4"],
     extras_require={

{rtc_tools-2.7.0.dev1 → rtc_tools-2.7.1/src/rtc_tools.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: rtc-tools
-Version: 2.7.0.dev1
+Version: 2.7.1
 Summary: Toolbox for control and optimization of water systems.
 Home-page: https://oss.deltares.nl/web/rtc-tools/home
-Download-URL: http://gitlab.com/deltares/rtc-tools/
+Download-URL: http://github.com/deltares/rtc-tools/
 Author: Deltares
 Maintainer: Deltares
 Platform: Windows
@@ -25,12 +25,13 @@ 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
 Requires-Dist: rtc-tools-channel-flow>=1.2.0
 Requires-Dist: defusedxml>=0.7.0
+Requires-Dist: importlib_metadata>=5.0.0; python_version < "3.10"
 Provides-Extra: netcdf
 Requires-Dist: netCDF4; extra == "netcdf"
 Provides-Extra: all
@@ -40,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.0.dev1 → rtc_tools-2.7.1}/src/rtc_tools.egg-info/requires.txt

@@ -1,10 +1,13 @@
-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-channel-flow>=1.2.0
 defusedxml>=0.7.0
 
+[:python_version < "3.10"]
+importlib_metadata>=5.0.0
+
 [all]
 netCDF4
 

{rtc_tools-2.7.0.dev1 → rtc_tools-2.7.1}/src/rtctools/_internal/casadi_helpers.py

@@ -5,12 +5,12 @@ import casadi as ca
 logger = logging.getLogger("rtctools")
 
 
-def is_affine(e, v):
+def is_affine(expr, symbols):
     try:
-        Af = ca.Function("f", [v], [ca.jacobian(e, v)]).expand()
-    except RuntimeError as e:
-        if "'eval_sx' not defined for" in str(e):
-            Af = ca.Function("f", [v], [ca.jacobian(e, v)])
+        Af = ca.Function("f", [symbols], [ca.jacobian(expr, symbols)]).expand()
+    except RuntimeError as error:
+        if "'eval_sx' not defined for" in str(error):
+            Af = ca.Function("f", [symbols], [ca.jacobian(expr, symbols)])
         else:
             raise
     return Af.sparsity_jac(0, 0).nnz() == 0
@@ -52,4 +52,12 @@ def interpolate(ts, xs, t, equidistant, mode=0):
         mode_str = "floor"
     else:
         mode_str = "ceil"
+
+    # CasADi fails if there is just a single point. Just "extrapolate" based on
+    # that point, just as CasADi would do for entries in 't' outside the range
+    # of 'ts'.
+    if len(ts) == 1:
+        assert xs.size1() == 1
+        return ca.vertcat(*[xs] * len(t))
+
     return ca.interp1d(ts, xs, t, mode_str, equidistant)

{rtc_tools-2.7.0.dev1 → rtc_tools-2.7.1}/src/rtctools/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-01-29T10:45:25+0100",
+ "date": "2025-07-23T09:21:39+0200",
  "dirty": false,
  "error": null,
- "full-revisionid": "41dd2517c9c4cd952cd3da53b551b988bc5b64ba",
- "version": "2.7.0.dev1"
+ "full-revisionid": "a3a2e2f821b5239481f43285b7dbf495a27de52e",
+ "version": "2.7.1"
 }
 '''  # END VERSION_JSON
 

{rtc_tools-2.7.0.dev1 → rtc_tools-2.7.1}/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.0.dev1 → rtc_tools-2.7.1}/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.0.dev1 → rtc_tools-2.7.1}/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.0.dev1 → rtc_tools-2.7.1}/src/rtctools/optimization/collocated_integrated_optimization_problem.py

@@ -670,7 +670,7 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
                 for ensemble_member in range(self.ensemble_size)
             ]
             if (
-                len(values) == 1 or (np.all(values) == values[0])
+                len(values) == 1 or all(v == values[0] for v in values)
             ) and parameter.name() not in dynamic_parameter_names:
                 constant_parameters.append(parameter)
                 constant_parameter_values.append(values[0])
@@ -898,11 +898,11 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
                     function_options,
                 )
 
+                # Expand the residual function if possible.
                 try:
                     dae_residual_function_integrated = dae_residual_function_integrated.expand()
                 except RuntimeError as e:
-                    # We only expect to fail if the DAE was an external function
-                    if "'eval_sx' not defined for External" in str(e):
+                    if "'eval_sx' not defined for" in str(e):
                         pass
                     else:
                         raise
@@ -933,13 +933,13 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
                     [dae_residual_collocated],
                     function_options,
                 )
+                # Expand the residual function if possible.
                 try:
                     self.__dae_residual_function_collocated = (
                         self.__dae_residual_function_collocated.expand()
                     )
                 except RuntimeError as e:
-                    # We only expect to fail if the DAE was an external function
-                    if "'eval_sx' not defined for External" in str(e):
+                    if "'eval_sx' not defined for" in str(e):
                         pass
                     else:
                         raise
@@ -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
@@ -2610,7 +2608,7 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
         else:
             tf = xf = ca.MX()
         t = ca.vertcat(t0, history_times[history_indices], times[indices], tf)
-        x = ca.vertcat(x0, history[history_indices], state[indices[0] : indices[-1] + 1], xf)
+        x = ca.vertcat(x0, history[history_indices], state[indices], xf)
 
         return x, t
 
@@ -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.0.dev1 → rtc_tools-2.7.1}/src/rtctools/optimization/control_tree_mixin.py

@@ -50,7 +50,7 @@ class ControlTreeMixin(OptimizationProblem):
         return options
 
     def discretize_control(self, variable, ensemble_member, times, offset):
-        control_indices = np.zeros(len(times), dtype=np.int16)
+        control_indices = np.zeros(len(times), dtype=np.int64)
         for branch, members in self.__branches.items():
             if ensemble_member not in members:
                 continue
@@ -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.0.dev1 → rtc_tools-2.7.1}/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.0.dev1 → rtc_tools-2.7.1}/src/rtctools/optimization/csv_mixin.py

@@ -98,6 +98,9 @@ class CSVMixin(IOMixin):
                 names=True,
                 encoding=None,
             )
+            if len(self.__ensemble.shape) == 0:
+                # If there is only one ensemble member, the array is 0-dimensional.
+                self.__ensemble = np.expand_dims(self.__ensemble, 0)
 
             logger.debug("CSVMixin: Read ensemble description")
 

{rtc_tools-2.7.0.dev1 → rtc_tools-2.7.1}/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.0.dev1 → rtc_tools-2.7.1}/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.0.dev1 → rtc_tools-2.7.1}/src/rtctools/optimization/modelica_mixin.py

@@ -1,10 +1,18 @@
+import importlib.resources
 import itertools
 import logging
+import sys
 from typing import Dict, Union
 
+# Python 3.9's importlib.metadata does not support the "group" parameter to
+# entry_points yet.
+if sys.version_info < (3, 10):
+    import importlib_metadata
+else:
+    from importlib import metadata as importlib_metadata
+
 import casadi as ca
 import numpy as np
-import pkg_resources
 import pymoca
 import pymoca.backends.casadi.api
 
@@ -174,9 +182,9 @@ class ModelicaMixin(OptimizationProblem):
         # Where imported model libraries are located.
         library_folders = self.modelica_library_folders.copy()
 
-        for ep in pkg_resources.iter_entry_points(group="rtctools.libraries.modelica"):
+        for ep in importlib_metadata.entry_points(group="rtctools.libraries.modelica"):
             if ep.name == "library_folder":
-                library_folders.append(pkg_resources.resource_filename(ep.module_name, ep.attrs[0]))
+                library_folders.append(str(importlib.resources.files(ep.module).joinpath(ep.attr)))
 
         compiler_options["library_folders"] = library_folders
 
@@ -326,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)
@@ -400,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.0.dev1 → rtc_tools-2.7.1}/src/rtctools/optimization/optimization_problem.py

@@ -199,12 +199,12 @@ class OptimizationProblem(DataStoreAccessor, metaclass=ABCMeta):
                         log_level = logging.INFO
                 logger.log(
                     log_level,
-                    "Solver succeeded with status {} ({}).".format(return_status, wall_clock_time),
+                    "Solver failed with status {} ({}).".format(return_status, wall_clock_time),
                 )
             except (AttributeError, ValueError):
                 logger.log(
                     log_level,
-                    "Solver succeeded with status {} ({}).".format(return_status, wall_clock_time),
+                    "Solver failed with status {} ({}).".format(return_status, wall_clock_time),
                 )
 
         # Do any postprocessing
@@ -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.0.dev1 → rtc_tools-2.7.1}/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.0.dev1 → rtc_tools-2.7.1}/src/rtctools/rtctoolsapp.py

@@ -1,9 +1,17 @@
+import importlib.resources
 import logging
 import os
 import shutil
 import sys
 from pathlib import Path
 
+# Python 3.9's importlib.metadata does not support the "group" parameter to
+# entry_points yet.
+if sys.version_info < (3, 10):
+    import importlib_metadata
+else:
+    from importlib import metadata as importlib_metadata
+
 import rtctools
 
 logging.basicConfig(format="%(asctime)s %(levelname)s %(message)s")
@@ -23,9 +31,6 @@ def copy_libraries(*args):
     if not os.path.exists(path):
         sys.exit("Folder '{}' does not exist".format(path))
 
-    # pkg_resources can be quite a slow import, so we do it here
-    import pkg_resources
-
     def _copytree(src, dst, symlinks=False, ignore=None):
         if not os.path.exists(dst):
             os.makedirs(dst)
@@ -56,11 +61,10 @@ def copy_libraries(*args):
     dst = Path(path)
 
     library_folders = []
-    for ep in pkg_resources.iter_entry_points(group="rtctools.libraries.modelica"):
+
+    for ep in importlib_metadata.entry_points(group="rtctools.libraries.modelica"):
         if ep.name == "library_folder":
-            library_folders.append(
-                Path(pkg_resources.resource_filename(ep.module_name, ep.attrs[0]))
-            )
+            library_folders.append(Path(importlib.resources.files(ep.module).joinpath(ep.attr)))
 
     tlds = {}
     for lf in library_folders:
@@ -100,11 +104,8 @@ def download_examples(*args):
     from zipfile import ZipFile
 
     version = rtctools.__version__
-    rtc_full_name = "rtc-tools-{}".format(version)
     try:
-        url = "https://gitlab.com/deltares/rtc-tools/-/archive/{}/{}.zip".format(
-            version, rtc_full_name
-        )
+        url = "https://github.com/deltares/rtc-tools/zipball/{}".format(version)
 
         opener = urllib.request.build_opener()
         urllib.request.install_opener(opener)
@@ -115,11 +116,12 @@ def download_examples(*args):
 
     with ZipFile(local_filename, "r") as z:
         target = path / "rtc-tools-examples"
-        prefix = "{}/examples/".format(rtc_full_name)
+        zip_folder_name = next(x for x in z.namelist() if x.startswith("Deltares-rtc-tools-"))
+        prefix = "{}/examples/".format(zip_folder_name.rstrip("/"))
         members = [x for x in z.namelist() if x.startswith(prefix)]
         z.extractall(members=members)
         shutil.move(prefix, target)
-        shutil.rmtree(rtc_full_name)
+        shutil.rmtree(zip_folder_name)
 
         sys.exit("Succesfully downloaded the RTC-Tools examples to '{}'".format(target.resolve()))
 

{rtc_tools-2.7.0.dev1 → rtc_tools-2.7.1}/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.0.dev1 → rtc_tools-2.7.1}/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.0.dev1 → rtc_tools-2.7.1}/src/rtctools/simulation/simulation_problem.py

@@ -1,13 +1,21 @@
 import copy
+import importlib.resources
 import itertools
 import logging
 import math
+import sys
 from collections import OrderedDict
 from typing import List, Union
 
+# Python 3.9's importlib.metadata does not support the "group" parameter to
+# entry_points yet.
+if sys.version_info < (3, 10):
+    import importlib_metadata
+else:
+    from importlib import metadata as importlib_metadata
+
 import casadi as ca
 import numpy as np
-import pkg_resources
 import pymoca
 import pymoca.backends.casadi.api
 
@@ -492,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
@@ -517,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
@@ -1059,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
 
@@ -1244,9 +1257,9 @@ class SimulationProblem(DataStoreAccessor):
         # Where imported model libraries are located.
         library_folders = self.modelica_library_folders.copy()
 
-        for ep in pkg_resources.iter_entry_points(group="rtctools.libraries.modelica"):
+        for ep in importlib_metadata.entry_points(group="rtctools.libraries.modelica"):
             if ep.name == "library_folder":
-                library_folders.append(pkg_resources.resource_filename(ep.module_name, ep.attrs[0]))
+                library_folders.append(str(importlib.resources.files(ep.module).joinpath(ep.attr)))
 
         compiler_options["library_folders"] = library_folders
 

{rtc_tools-2.7.0.dev1 → rtc_tools-2.7.1}/src/rtctools/util.py

@@ -110,6 +110,7 @@ def run_optimization_problem(
             "GoalProgrammingMixin",
             "PIMixin",
             "CSVMixin",
+            "IOMixin",
             "ModelicaMixin",
             "PlanningMixin",
             "ControlTreeMixin",