rtc-tools 2.7.0a2__tar.gz → 2.7.0a3__tar.gz

{rtc-tools-2.7.0a2/src/rtc_tools.egg-info → rtc-tools-2.7.0a3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rtc-tools
-Version: 2.7.0a2
+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

{rtc-tools-2.7.0a2 → rtc-tools-2.7.0a3}/setup.py

@@ -48,7 +48,7 @@ setup(
         "numpy >= 1.16.0, <1.26",
         "scipy >= 1.0.0, <1.11",
         "pymoca >= 0.9.1, == 0.9.*",
-        "rtc-tools-channel-flow >= 1.1.0",
+        "rtc-tools-channel-flow >= 1.2.0",
         "defusedxml >= 0.7.0",
     ],
     tests_require=["pytest", "pytest-runner", "netCDF4"],

{rtc-tools-2.7.0a2 → rtc-tools-2.7.0a3/src/rtc_tools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rtc-tools
-Version: 2.7.0a2
+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

{rtc-tools-2.7.0a2 → rtc-tools-2.7.0a3}/src/rtc_tools.egg-info/requires.txt

@@ -2,7 +2,7 @@ casadi==3.6.*,>=3.6.3
 numpy<1.26,>=1.16.0
 scipy<1.11,>=1.0.0
 pymoca==0.9.*,>=0.9.1
-rtc-tools-channel-flow>=1.1.0
+rtc-tools-channel-flow>=1.2.0
 defusedxml>=0.7.0
 
 [all]

{rtc-tools-2.7.0a2 → rtc-tools-2.7.0a3}/src/rtctools/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-05-14T15:15:45+0200",
+ "date": "2024-07-23T15:26:53+0200",
  "dirty": false,
  "error": null,
- "full-revisionid": "6d06af067e4be71ea3b47593feb9be8ee7c37adc",
- "version": "2.7.0a2"
+ "full-revisionid": "4657ff3b5634df60af117b022fca4e968b88feb7",
+ "version": "2.7.0a3"
 }
 '''  # END VERSION_JSON
 

{rtc-tools-2.7.0a2 → rtc-tools-2.7.0a3}/src/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

{rtc-tools-2.7.0a2 → rtc-tools-2.7.0a3}/src/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()