rtc-tools 2.7.0a1__py3-none-any.whl → 2.7.0a3__py3-none-any.whl

{rtc_tools-2.7.0a1.dist-info → rtc_tools-2.7.0a3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rtc-tools
-Version: 2.7.0a1
+Version: 2.7.0a3
 Summary: Toolbox for control and optimization of water systems.
 Home-page: https://oss.deltares.nl/web/rtc-tools/home
 Author: Deltares
@@ -30,7 +30,7 @@ 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: rtc-tools-channel-flow >=1.2.0
 Requires-Dist: defusedxml >=0.7.0
 Provides-Extra: all
 Requires-Dist: netCDF4 ; extra == 'all'

{rtc_tools-2.7.0a1.dist-info → rtc_tools-2.7.0a3.dist-info}/RECORD

@@ -1,5 +1,5 @@
 rtctools/__init__.py,sha256=91hvS2-ryd2Pvw0COpsUzTwJwSnTZ035REiej-1hNI4,107
-rtctools/_version.py,sha256=My52FWqz9UB3_PwxQjfVCPUkHjej_S48gNc1rsNpaKc,499
+rtctools/_version.py,sha256=NDNDfYdfbfnXYIbOXMs5aKbrACG7Okc9i2sbnNx2dZU,499
 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
@@ -10,7 +10,7 @@ rtctools/_internal/debug_check_helpers.py,sha256=UgQTEPw4PyR7MbYLewSSWQqTwQj7xr5
 rtctools/data/__init__.py,sha256=EllgSmCdrlvQZSd1VilvjPaeYJGhY9ErPiQtedmuFoA,157
 rtctools/data/csv.py,sha256=iYOEED3AaNxt4ews_aAkHfl9Tq9a-9vjxvYwjVR_lQE,5231
 rtctools/data/netcdf.py,sha256=xpk4Ggl7gItNG6lO7p3OJPR-elK8_CiCtxUI7cX0gwk,19109
-rtctools/data/pi.py,sha256=Ni1hBDdhQdcWYO-NUPhKA1WJdzbSXjZc5w5xauOBcJM,45437
+rtctools/data/pi.py,sha256=VZNLtaYTdyXFVbM6rLM8BKMnyRs-H3NwKz955Mp-KTc,46988
 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
@@ -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=wGRIOm4AHAy75R7cbqeA13-Qy1ED3RY3Yc5Hvtmv6PY,48541
-rtc_tools-2.7.0a1.dist-info/COPYING.LESSER,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
-rtc_tools-2.7.0a1.dist-info/METADATA,sha256=p33wEk1F8t8jCHyV1bUe5R4JcedANOtp-9NsTH1mWBc,1494
-rtc_tools-2.7.0a1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-rtc_tools-2.7.0a1.dist-info/entry_points.txt,sha256=-x622IB_l1duw2M6t6syfQ4yzOiQTp0IZxKGcYRgWgk,151
-rtc_tools-2.7.0a1.dist-info/top_level.txt,sha256=pnBrb58PFPd1kp1dqa-JHU7R55h3alDNJIJnF3Jf9Dw,9
-rtc_tools-2.7.0a1.dist-info/RECORD,,
+rtctools/simulation/simulation_problem.py,sha256=8k3MjznzvFIut04NAiu7UAhfndAvNTkQFsO9vbmNd-0,49567
+rtc_tools-2.7.0a3.dist-info/COPYING.LESSER,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+rtc_tools-2.7.0a3.dist-info/METADATA,sha256=o9lVOLg5xdv9pe2GRSjdPr0_6ubcI7SvqPc6jOU9gRc,1494
+rtc_tools-2.7.0a3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+rtc_tools-2.7.0a3.dist-info/entry_points.txt,sha256=-x622IB_l1duw2M6t6syfQ4yzOiQTp0IZxKGcYRgWgk,151
+rtc_tools-2.7.0a3.dist-info/top_level.txt,sha256=pnBrb58PFPd1kp1dqa-JHU7R55h3alDNJIJnF3Jf9Dw,9
+rtc_tools-2.7.0a3.dist-info/RECORD,,

rtctools/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-04-25T06:42:12+0000",
+ "date": "2024-07-23T15:26:53+0200",
  "dirty": false,
  "error": null,
- "full-revisionid": "e3d59506cabe8df7e05acd089ccf574e106a577f",
- "version": "2.7.0a1"
+ "full-revisionid": "4657ff3b5634df60af117b022fca4e968b88feb7",
+ "version": "2.7.0a3"
 }
 '''  # END VERSION_JSON
 

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
@@ -911,7 +916,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 +1175,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/simulation/simulation_problem.py

@@ -419,7 +419,6 @@ class SimulationProblem(DataStoreAccessor):
             start_values = {}
 
             # Attempt to cast var.start to python type
-            start_value_is_symbolic = False
             mx_start = ca.MX(var.start)
             if mx_start.is_constant():
                 # cast var.start to python type
@@ -427,7 +426,6 @@ class SimulationProblem(DataStoreAccessor):
                 if start_value_pymoca is not None and start_value_pymoca != 0:
                     start_values["modelica"] = start_value_pymoca
             else:
-                start_value_is_symbolic = True
                 start_values["modelica"] = mx_start
 
             if not var.fixed:
@@ -479,8 +477,8 @@ class SimulationProblem(DataStoreAccessor):
                 input_source = "modelica"
                 source_description = "modelica file or default value"
             start_val = start_values.get(input_source, None)
-            is_numeric = start_val is not None and not start_value_is_symbolic
-            numeric_start_val = start_val if is_numeric else 0.0
+            start_is_numeric = start_val is not None and not isinstance(start_val, ca.MX)
+            numeric_start_val = start_val if start_is_numeric else 0.0
             if len(start_values) > 1:
                 logger.warning(
                     "Initialize: Multiple initial values for {} are provided: {}.".format(
@@ -500,10 +498,12 @@ class SimulationProblem(DataStoreAccessor):
 
             # Add a residual for the difference between the state and its starting expression
             start_expr = start_val
+            min_is_symbolic = isinstance(var.min, ca.MX)
+            max_is_symbolic = isinstance(var.max, ca.MX)
             if var.fixed:
                 # Set bounds to be equal to each other, such that IPOPT can
                 # turn the decision variable into a parameter.
-                if var.min != -np.inf or var.max != np.inf:
+                if min_is_symbolic or max_is_symbolic or var.min != -np.inf or var.max != np.inf:
                     logger.info(
                         "Initialize: bounds of {} will be overwritten".format(var_name)
                         + " by the start value given by {}.".format(source_description)
@@ -515,7 +515,7 @@ class SimulationProblem(DataStoreAccessor):
                 minimized_residuals.append((var.symbol - start_expr) / var_nominal)
 
             # Check that the start_value is in between the variable bounds.
-            if start_val is not None and is_numeric:
+            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)
@@ -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()