rtc-tools 2.7.0a2__py3-none-any.whl → 2.7.0.dev1__py3-none-any.whl

{rtc_tools-2.7.0a2.dist-info → rtc_tools-2.7.0.dev1.dist-info}/METADATA

@@ -1,12 +1,11 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: rtc-tools
-Version: 2.7.0a2
+Version: 2.7.0.dev1
 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/
 Author: Deltares
 Maintainer: Deltares
-License: UNKNOWN
-Download-URL: http://gitlab.com/deltares/rtc-tools/
 Platform: Windows
 Platform: Linux
 Platform: Mac OS-X
@@ -24,20 +23,29 @@ Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX
 Classifier: Operating System :: Unix
 Classifier: Operating System :: MacOS
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 License-File: COPYING.LESSER
-Requires-Dist: casadi ==3.6.*,>=3.6.3
-Requires-Dist: numpy <1.26,>=1.16.0
-Requires-Dist: scipy <1.11,>=1.0.0
-Requires-Dist: pymoca ==0.9.*,>=0.9.1
-Requires-Dist: rtc-tools-channel-flow >=1.1.0
-Requires-Dist: defusedxml >=0.7.0
-Provides-Extra: all
-Requires-Dist: netCDF4 ; extra == 'all'
+Requires-Dist: casadi!=3.6.6,==3.6.*,>=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
 Provides-Extra: netcdf
-Requires-Dist: netCDF4 ; extra == 'netcdf'
+Requires-Dist: netCDF4; extra == "netcdf"
+Provides-Extra: all
+Requires-Dist: netCDF4; extra == "all"
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: maintainer
+Dynamic: platform
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 RTC-Tools is the Deltares toolbox for control and optimization of water systems.
 
-
-

{rtc_tools-2.7.0a2.dist-info → rtc_tools-2.7.0.dev1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 rtctools/__init__.py,sha256=91hvS2-ryd2Pvw0COpsUzTwJwSnTZ035REiej-1hNI4,107
-rtctools/_version.py,sha256=khi7aLWt95iU8AN9lfjGJYvYFy3VrtunF5V_MRtL7tI,499
+rtctools/_version.py,sha256=ZJWaMwzY28qcZR8VLceCjHCoMmz_54mkIUutjeH3dyQ,502
 rtctools/rtctoolsapp.py,sha256=UnkuiJhv0crEEVs8H6PYvMuc2y_q6V_xLuyKEgXj9GM,4200
 rtctools/util.py,sha256=PaeKfDUA174ODZbY5fZjCTf-F-TdhW7yEuP189Ro190,9075
 rtctools/_internal/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -8,29 +8,29 @@ rtctools/_internal/caching.py,sha256=p4gqSL7kCI7Hff-KjMEP7mhJCQSiU_lYm2MR7E18gBM
 rtctools/_internal/casadi_helpers.py,sha256=oAf5zyFkZbaMhvhgMnQkOi2A6dBOzj-VAUkYwBf-Jxk,1410
 rtctools/_internal/debug_check_helpers.py,sha256=UgQTEPw4PyR7MbYLewSSWQqTwQj7xr5yUBk820O9Kk4,1084
 rtctools/data/__init__.py,sha256=EllgSmCdrlvQZSd1VilvjPaeYJGhY9ErPiQtedmuFoA,157
-rtctools/data/csv.py,sha256=iYOEED3AaNxt4ews_aAkHfl9Tq9a-9vjxvYwjVR_lQE,5231
+rtctools/data/csv.py,sha256=hEpoTH3nhZaAvRN4r-9-nYeAjaFiNDRoiZWg8GxM3yo,5539
 rtctools/data/netcdf.py,sha256=xpk4Ggl7gItNG6lO7p3OJPR-elK8_CiCtxUI7cX0gwk,19109
-rtctools/data/pi.py,sha256=Ni1hBDdhQdcWYO-NUPhKA1WJdzbSXjZc5w5xauOBcJM,45437
+rtctools/data/pi.py,sha256=5w50zWgI79Vu5EMMz-MKoManXYqsjxfFgcZN6Z3eeiQ,46638
 rtctools/data/rtc.py,sha256=1yGJZGq2Z36MYLiLuZaHnxupL4mgw-Wuu54PAG05kcM,9077
 rtctools/data/storage.py,sha256=67J4BRTl0AMEzlKNZ8Xdpy_4cGtwx8Lo_tL2n0G4S9w,13206
 rtctools/data/interpolation/__init__.py,sha256=GBubCIT5mFoSTV-lOk7cpwvZekNMEe5bvqSQJ9HE34M,73
 rtctools/data/interpolation/bspline.py,sha256=qevB842XWCH3fWlWMBqKMy1mw37ust-0YtSnb9PKCEc,948
-rtctools/data/interpolation/bspline1d.py,sha256=hQrok4rrBcJV_HciuFjZYSwrSP8w_VufQRP6JLZhA7U,6106
+rtctools/data/interpolation/bspline1d.py,sha256=HAh7m5xLBuiFKzMzuYEqZX_GmCPChKjV7ynTS6iRZOc,6166
 rtctools/data/interpolation/bspline2d.py,sha256=ScmX0fPDxbUVtj3pbUE0L7UJocqroD_6fUT-4cvdRMc,1693
 rtctools/optimization/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rtctools/optimization/collocated_integrated_optimization_problem.py,sha256=Bv1a1O4QTAdIpe9SOA9_oEDDph-oj-9q5yfN4SFMdW8,131343
 rtctools/optimization/control_tree_mixin.py,sha256=CC6TWp3kFQgMokx6213pRLx9iY17Fd0VcwG4Wpwa0Uo,8974
 rtctools/optimization/csv_lookup_table_mixin.py,sha256=h4WKuPR1BJbYuJfQ9lx4rXalB6yYK-zajINabRL7BrA,17298
 rtctools/optimization/csv_mixin.py,sha256=sRp5paHWfCw2bz-23Nw-HdFLS3CZTpVwaBdFo98DbvE,12252
-rtctools/optimization/goal_programming_mixin.py,sha256=GK25DrbAY_rMsra080pSCDZwzLQNN2Ppd-2d0_FEllg,32999
-rtctools/optimization/goal_programming_mixin_base.py,sha256=oh9CsEiyYTmthcfvRbX-9Z9bIo6SHv_DCiVt9kx0sjI,43781
+rtctools/optimization/goal_programming_mixin.py,sha256=r2pPzcqi-VlstPx4CdtUT0JeemduiYBV5zeH4kA9QGs,33301
+rtctools/optimization/goal_programming_mixin_base.py,sha256=IvA3cfJmUW9SaDGATD7r4Rrjku9T4oI2H68imPTlq2A,43816
 rtctools/optimization/homotopy_mixin.py,sha256=Kh0kMfxB-Fo1FBGW5tPOQk24Xx_Mmw_p0YuSQotdkMU,6905
 rtctools/optimization/initial_state_estimation_mixin.py,sha256=74QYfG-VYYTNVg-kAnCG6QoY3_sUmaID0ideF7bPkkY,3116
 rtctools/optimization/io_mixin.py,sha256=AsZQ7YOUcUbWoczmjTXaSje5MUEsPNbQyZBJ6qzSjzU,11821
 rtctools/optimization/linearization_mixin.py,sha256=mG5S7uwvwDydw-eBPyQKnLyKoy08EBjQh25vu97afhY,1049
 rtctools/optimization/linearized_order_goal_programming_mixin.py,sha256=LQ2qpYt0YGLpEoerif4FJ5wwzq16q--27bsRjcqIU5A,9087
 rtctools/optimization/min_abs_goal_programming_mixin.py,sha256=WMOv9EF8cfDJgTunzXfI_cUmBSQK26u1HJB_9EAarfM,14031
-rtctools/optimization/modelica_mixin.py,sha256=6rotTEge4l2oDib4tnG2ccXqG1ryEzNxbRkk_StFAHg,17769
+rtctools/optimization/modelica_mixin.py,sha256=9MnZ2tz9WWMeUg7UuS7TNOuqvfZhuTDvZsDfS6HcBIo,17796
 rtctools/optimization/netcdf_mixin.py,sha256=-zkXh3sMYE50c3kHsrmUVGWMSFm-0cXQpGrCm0yn-Tc,7563
 rtctools/optimization/optimization_problem.py,sha256=qzpc81NaZMeoXKuayFmBF15iXYuNAk5yxmaER_Gcz_A,44131
 rtctools/optimization/pi_mixin.py,sha256=n_ZyifuNPxcRoJXKR6Ks7DgK_b7-EToYJ23_khOwpzo,11786
@@ -41,10 +41,10 @@ rtctools/simulation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSu
 rtctools/simulation/csv_mixin.py,sha256=rGDUFPsqGHmF0_dWdXeWzWzMpkPmwCNweTBVrwSh31g,6704
 rtctools/simulation/io_mixin.py,sha256=SJasNGI--OQ9Y-Z61oeeaGCxSrNddYz4AOVfJYbmf74,6209
 rtctools/simulation/pi_mixin.py,sha256=vcizArZsOn7tGlSFCsUmkjmRFA1A1kMNqUllLlkVc9Y,9831
-rtctools/simulation/simulation_problem.py,sha256=TAG8J8td-23UgRz_I0Nz7yp9v_HT8ayblyYPtqbLyZo,48647
-rtc_tools-2.7.0a2.dist-info/COPYING.LESSER,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
-rtc_tools-2.7.0a2.dist-info/METADATA,sha256=OISYetGzEVCx1AWcMEcqOZpd-HT-0p6CftZd3uicWx4,1494
-rtc_tools-2.7.0a2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-rtc_tools-2.7.0a2.dist-info/entry_points.txt,sha256=-x622IB_l1duw2M6t6syfQ4yzOiQTp0IZxKGcYRgWgk,151
-rtc_tools-2.7.0a2.dist-info/top_level.txt,sha256=pnBrb58PFPd1kp1dqa-JHU7R55h3alDNJIJnF3Jf9Dw,9
-rtc_tools-2.7.0a2.dist-info/RECORD,,
+rtctools/simulation/simulation_problem.py,sha256=8k3MjznzvFIut04NAiu7UAhfndAvNTkQFsO9vbmNd-0,49567
+rtc_tools-2.7.0.dev1.dist-info/COPYING.LESSER,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+rtc_tools-2.7.0.dev1.dist-info/METADATA,sha256=FDvd6uh5Dduh-AaeJvVDay1GYtocMqUDwKPyW6JflXM,1691
+rtc_tools-2.7.0.dev1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+rtc_tools-2.7.0.dev1.dist-info/entry_points.txt,sha256=DVS8sWf3b9ph9h8srEr6zmQ7ZKGwblwgZgGPZg-jRNQ,150
+rtc_tools-2.7.0.dev1.dist-info/top_level.txt,sha256=pnBrb58PFPd1kp1dqa-JHU7R55h3alDNJIJnF3Jf9Dw,9
+rtc_tools-2.7.0.dev1.dist-info/RECORD,,

{rtc_tools-2.7.0a2.dist-info → rtc_tools-2.7.0.dev1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{rtc_tools-2.7.0a2.dist-info → rtc_tools-2.7.0.dev1.dist-info}/entry_points.txt

@@ -1,4 +1,3 @@
 [console_scripts]
 rtc-tools-copy-libraries = rtctools.rtctoolsapp:copy_libraries
 rtc-tools-download-examples = rtctools.rtctoolsapp:download_examples
-

rtctools/_version.py

@@ -1,5 +1,5 @@
 
-# This file was generated by 'versioneer.py' (0.18) from
+# This file was generated by 'versioneer.py' (0.29) from
 # revision-control system data, or from the parent directory name of an
 # unpacked source archive. Distribution tarballs contain a pre-generated copy
 # of this file.
@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-05-14T15:15:45+0200",
+ "date": "2025-01-29T10:45:25+0100",
  "dirty": false,
  "error": null,
- "full-revisionid": "6d06af067e4be71ea3b47593feb9be8ee7c37adc",
- "version": "2.7.0a2"
+ "full-revisionid": "41dd2517c9c4cd952cd3da53b551b988bc5b64ba",
+ "version": "2.7.0.dev1"
 }
 '''  # END VERSION_JSON
 

rtctools/data/csv.py

@@ -1,6 +1,7 @@
 import logging
 import sys
 from datetime import datetime
+from typing import Union
 
 import numpy as np
 
@@ -41,6 +42,21 @@ def _boolean_to_nan(data, fname):
     return data
 
 
+def _string_to_datetime(string: Union[str, bytes]) -> datetime:
+    """Convert a string to a datetime object."""
+    if isinstance(string, bytes):
+        string = string.decode("utf-8")
+    return datetime.strptime(string, "%Y-%m-%d %H:%M:%S")
+
+
+def _string_to_float(string: Union[str, bytes]) -> float:
+    """Convert a string to a float."""
+    if isinstance(string, bytes):
+        string = string.decode("utf-8")
+    string = string.replace(",", ".")
+    return float(string)
+
+
 def load(fname, delimiter=",", with_time=False):
     """
     Check delimiter of csv and read contents to an array. Assumes no date-time conversion needed.
@@ -53,7 +69,7 @@ def load(fname, delimiter=",", with_time=False):
     """
     c = {}
     if with_time:
-        c.update({0: lambda str: datetime.strptime(str.decode("utf-8"), "%Y-%m-%d %H:%M:%S")})
+        c.update({0: _string_to_datetime})
 
     # Check delimiter of csv file. If semicolon, check if decimal separator is
     # a comma.
@@ -73,12 +89,7 @@ def load(fname, delimiter=",", with_time=False):
             # If commas are used as decimal separator, we need additional
             # converters.
             if n_comma_decimal:
-                c.update(
-                    {
-                        i + len(c): lambda str: float(str.decode("utf-8").replace(",", "."))
-                        for i in range(1 + n_semicolon - len(c))
-                    }
-                )
+                c.update({i + len(c): _string_to_float for i in range(1 + n_semicolon - len(c))})
 
     # Read the csv file and convert to array
     try:

rtctools/data/interpolation/bspline1d.py

@@ -55,6 +55,7 @@ class BSpline1D(BSpline):
         epsilon=1e-7,
         delta=1e-4,
         interior_pts=None,
+        ipopt_options=None,
     ):
         """
         fit() returns a tck tuple like scipy.interpolate.splrep, but adjusts
@@ -153,7 +154,10 @@ class BSpline1D(BSpline):
         nlp = {"x": c, "f": f, "g": g}
         my_solver = "ipopt"
         solver = nlpsol(
-            "solver", my_solver, nlp, {"print_time": 0, "expand": True, "ipopt": {"print_level": 0}}
+            "solver",
+            my_solver,
+            nlp,
+            {"print_time": 0, "expand": True, "ipopt": ipopt_options},
         )
         sol = solver(lbg=lbg, ubg=ubg)
         stats = solver.stats()

rtctools/data/pi.py

@@ -369,8 +369,6 @@ class Timeseries:
         self.__folder = folder
         self.__basename = basename
 
-        self.__path_xml = os.path.join(self.__folder, basename + ".xml")
-
         self.__internal_dtype = np.float64
         self.__pi_dtype = np.float32
 
@@ -378,7 +376,7 @@ class Timeseries:
         if self.make_new_file:
             self.__reset_xml_tree()
         else:
-            self.__tree = DefusedElementTree.parse(self.__path_xml)
+            self.__tree = DefusedElementTree.parse(self.path)
             self.__xml_root = self.__tree.getroot()
 
         self.__values = [{}]
@@ -801,13 +799,20 @@ class Timeseries:
         # Add series to xml
         self.__xml_root.append(series)
 
-    def write(self):
+    def write(self, output_folder=None, output_filename=None) -> None:
         """
         Writes the time series data to disk.
+
+        :param output_folder:   The folder in which the output file is located.
+                                If None, the original folder is used.
+        :param output_filename: The name of the output file without extension.
+                                If None, the original filename is used.
         """
+        xml_path = self.output_path(output_folder, output_filename)
+        binary_path = self.output_binary_path(output_folder, output_filename)
 
         if self.__binary:
-            f = io.open(self.binary_path, "wb")
+            f = io.open(binary_path, "wb")
 
         if self.make_new_file:
             # Force reinitialization in case write() is called more than once
@@ -876,29 +881,26 @@ class Timeseries:
                     events = series.findall("pi:event", ns)
 
                     t = self.__start_datetime
-                    for i in range(min(len(events), len(values))):
+                    for i, value in enumerate(values):
                         if self.dt is None:
                             t = self.times[i]
-                        # Set the date/time, so that any date/time steps that
-                        # are wrong in the placeholder file are corrected.
-                        events[i].set("date", t.strftime("%Y-%m-%d"))
-                        events[i].set("time", t.strftime("%H:%M:%S"))
 
-                        # Set the value
-                        events[i].set("value", str(values[i]))
-                        if self.dt:
-                            t += self.dt
-                    for i in range(len(events), len(values)):
-                        if self.dt is None:
-                            t = self.times[i]
-                        event = ET.Element("pi:event")
+                        if i < len(events):
+                            event = events[i]
+                        else:
+                            event = ET.Element("pi:event")
+                            series.append(event)
+
+                        # Always set the date/time, so that any date/time steps
+                        # that are wrong in the placeholder file are corrected.
                         event.set("date", t.strftime("%Y-%m-%d"))
                         event.set("time", t.strftime("%H:%M:%S"))
+
                         if nans[i]:
                             event.set("value", miss_val)
                         else:
-                            event.set("value", str(values[i]))
-                        series.append(event)
+                            event.set("value", str(value))
+
                         if self.dt:
                             t += self.dt
 
@@ -911,7 +913,7 @@ class Timeseries:
             f.close()
 
         self.format_xml_data()
-        self.__tree.write(self.__path_xml)
+        self.__tree.write(xml_path)
 
     def format_xml_data(self):
         """
@@ -1170,16 +1172,45 @@ class Timeseries:
         self.__end_datetime = end_datetime
 
     @property
-    def path(self):
-        return self.__path_xml
+    def path(self) -> str:
+        """
+        The path to the original xml file.
+        """
+        return os.path.join(self.__folder, self.__basename + ".xml")
 
     @property
-    def binary_path(self):
+    def binary_path(self) -> str:
         """
-        The path for the binary data .bin file.
+        The path to the original binary data .bin file.
         """
         return os.path.join(self.__folder, self.__basename + ".bin")
 
+    def _output_path_without_extension(self, output_folder=None, output_filename=None) -> str:
+        """
+        Get the output path without file extension.
+        """
+        if output_folder is None:
+            output_folder = self.__folder
+        if output_filename is None:
+            output_filename = self.__basename
+        return os.path.join(output_folder, output_filename)
+
+    def output_path(self, output_folder=None, output_filename=None) -> str:
+        """
+        Get the path to the output xml file.
+
+        The optional arguments are the same as in :py:method:`write`.
+        """
+        return self._output_path_without_extension(output_folder, output_filename) + ".xml"
+
+    def output_binary_path(self, output_folder=None, output_filename=None) -> str:
+        """
+        Get the path to the output binary file.
+
+        The optional arguments are the same as in :py:method:`write`.
+        """
+        return self._output_path_without_extension(output_folder, output_filename) + ".bin"
+
     def items(self, ensemble_member=0):
         """
         Returns an iterator over all timeseries IDs and value arrays for the given

rtctools/optimization/goal_programming_mixin.py

@@ -667,6 +667,7 @@ class GoalProgrammingMixin(_GoalProgrammingMixinBase):
         logger.info("Starting goal programming")
 
         success = False
+        self.skip_priority = False
 
         self.__constraint_store = [OrderedDict() for ensemble_member in range(self.ensemble_size)]
         self.__path_constraint_store = [
@@ -691,6 +692,13 @@ class GoalProgrammingMixin(_GoalProgrammingMixinBase):
             # Call the pre priority hook
             self.priority_started(priority)
 
+            if self.skip_priority:
+                logger.info(
+                    "priority {} was removed in priority_started. No optimization problem "
+                    "is solved at this priority.".format(priority)
+                )
+                continue
+
             (
                 self.__subproblem_epsilons,
                 self.__subproblem_objectives,

rtctools/optimization/goal_programming_mixin_base.py

@@ -1081,6 +1081,7 @@ class _GoalProgrammingMixinBase(OptimizationProblem, metaclass=ABCMeta):
 
         :param priority: The priority level that was started.
         """
+        self.skip_priority = False
         pass
 
     def priority_completed(self, priority: int) -> None:

rtctools/optimization/modelica_mixin.py

@@ -54,8 +54,8 @@ class ModelicaMixin(OptimizationProblem):
             self.__pymoca_model = pymoca.backends.casadi.api.transfer_model(
                 kwargs["model_folder"], model_name, compiler_options
             )
-        except RuntimeError as error:
-            if compiler_options.get("cache", False):
+        except (RuntimeError, ModuleNotFoundError) as error:
+            if not compiler_options.get("cache", False):
                 raise error
             compiler_options["cache"] = False
             logger.warning(f"Loading model {model_name} using a cache file failed: {error}.")

rtctools/simulation/simulation_problem.py

@@ -838,6 +838,8 @@ class SimulationProblem(DataStoreAccessor):
         self.set_var("time", self.get_current_time() + dt)
 
         # take a step
+        if np.isnan(self.__state_vector).any():
+            logger.error("Found a nan in the state vector (before making the step)")
         guess = self.__state_vector[: self.__n_states]
         if len(self.__mx["parameters"]) > 0:
             next_state = self.__do_step(
@@ -845,6 +847,23 @@ class SimulationProblem(DataStoreAccessor):
             )
         else:
             next_state = self.__do_step(guess, dt, self.__state_vector)
+
+        try:
+            if np.isnan(next_state).any():
+                index_to_name = {index[0]: name for name, index in self.__indices.items()}
+                named_next_state = {
+                    index_to_name[i]: float(next_state[i]) for i in range(0, next_state.shape[0])
+                }
+                variables_with_nan = [
+                    name for name, value in named_next_state.items() if np.isnan(value)
+                ]
+                if variables_with_nan:
+                    logger.error(
+                        f"Found nan(s) in the next_state vector for:\n\t {variables_with_nan}"
+                    )
+        except (KeyError, IndexError, TypeError):
+            logger.warning("Something went wrong while checking for nans in the next_state vector")
+
         # Check convergence of rootfinder
         rootfinder_stats = self.__do_step.stats()