rtc-tools 2.5.1rc1__py3-none-any.whl → 2.5.2a2__py3-none-any.whl

{rtc_tools-2.5.1rc1.dist-info → rtc_tools-2.5.2a2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rtc-tools
-Version: 2.5.1rc1
+Version: 2.5.2a2
 Summary: Toolbox for control and optimization of water systems.
 Home-page: https://oss.deltares.nl/web/rtc-tools/home
 Author: Deltares
@@ -27,8 +27,8 @@ Classifier: Operating System :: MacOS
 Requires-Python: >=3.5
 License-File: COPYING.LESSER
 Requires-Dist: casadi (==3.5.*)
-Requires-Dist: numpy (>=1.16.0)
-Requires-Dist: scipy (>=1.0.0)
+Requires-Dist: numpy (<1.23,>=1.16.0)
+Requires-Dist: scipy (<1.11,>=1.0.0)
 Requires-Dist: pymoca (==0.9.*)
 Requires-Dist: rtc-tools-channel-flow (>=1.1.0)
 Provides-Extra: all

{rtc_tools-2.5.1rc1.dist-info → rtc_tools-2.5.2a2.dist-info}/RECORD

@@ -1,5 +1,5 @@
 rtctools/__init__.py,sha256=GzuYmrfvai2LnOnLGZUweYWn4SJQH9txwzwVO-ykvN4,106
-rtctools/_version.py,sha256=YkGn2tyAZqKSTb3t_ABQJYEE21LoH2A56D5O1RPOGJY,500
+rtctools/_version.py,sha256=0K1yImT9X9wdqhZb9KmjXsI77YhAB2XLta4BABO1ADg,499
 rtctools/rtctoolsapp.py,sha256=tK8hLfozegtH9kY5bmAox8lCE427uhxBWEp5pBqhiSA,4193
 rtctools/util.py,sha256=SkYvRJPZVuWXlWk3NMO9Xdx_Vy7vhO_qPMN0nJ96Vdc,7371
 rtctools/_internal/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -10,7 +10,7 @@ rtctools/_internal/debug_check_helpers.py,sha256=YDPNB2yVY2Lkztoz8GabG0TX3-2CS0D
 rtctools/data/__init__.py,sha256=k4WorSsD-Y8l2meIYHPaSOdGEgonribLkyoMASAhe90,157
 rtctools/data/csv.py,sha256=1pEYJ2Y0pxNFONH0iwacAbkKb3959lyqA_-jQ0O4CPo,4947
 rtctools/data/netcdf.py,sha256=QpAzAowSdmbJRkuPLCFbhoyGpecxZENhJi9Tjc7YDOY,18692
-rtctools/data/pi.py,sha256=o_9whVJofk7F8yvzz9rZdRqyer8FSXZ0TePX5GHa7OQ,42336
+rtctools/data/pi.py,sha256=m7KGieJ6d5j7jQhsc_XVFhEeyMH7j8PvKAcVJ2xpkI4,42363
 rtctools/data/rtc.py,sha256=2cPDTuU0T4GiueG8ESHUPObtkDY9jahEBQ48Bc-CCeg,8853
 rtctools/data/storage.py,sha256=A2U1OuBzzTYADCN_BhLf9mmIQN4BZ_GNG_DdN_JoGoo,13011
 rtctools/data/interpolation/__init__.py,sha256=GBubCIT5mFoSTV-lOk7cpwvZekNMEe5bvqSQJ9HE34M,73
@@ -18,21 +18,21 @@ rtctools/data/interpolation/bspline.py,sha256=xg1PqXlbpBZ5dPE5ngvdnJ7utSZyx8BgMq
 rtctools/data/interpolation/bspline1d.py,sha256=xLlxKrYNr-DADQ6UILGqgiJCAN-Db40USJa-XOmauFg,6002
 rtctools/data/interpolation/bspline2d.py,sha256=RJO9XbjrNFNgkYjS88l-c4miu9xW1yroACpQ9v0u7bg,1607
 rtctools/optimization/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rtctools/optimization/collocated_integrated_optimization_problem.py,sha256=r04BEwFGcanANTgbAWCkaoqOOnci8hGBVsn3ls-rx2I,116362
+rtctools/optimization/collocated_integrated_optimization_problem.py,sha256=G2goCNLx8qARaR0JawJum0Fr4jxtiQAAQAXxaqS4m00,116465
 rtctools/optimization/control_tree_mixin.py,sha256=mYHJUaskdeChCrqSTIPpFXwBU1JcwlwLtUTjwvR7CQ8,9030
-rtctools/optimization/csv_lookup_table_mixin.py,sha256=GJXXTXHGcM_GOeRNhfOiqF7EILeve4Jnu_gc_FcBQio,16296
+rtctools/optimization/csv_lookup_table_mixin.py,sha256=mEZdl1ca69K9ptJdKxCGIle4MrAwBTB4AJiVYQctyZg,16651
 rtctools/optimization/csv_mixin.py,sha256=FvMcuLlKu-YJo2NNudwMUUYKNb6HN4cevndWjlo5nis,11624
-rtctools/optimization/goal_programming_mixin.py,sha256=EIvgmL-BiJhij2ajE6erswtRD447A26d5Yh4MeoAEGY,31601
+rtctools/optimization/goal_programming_mixin.py,sha256=itns49Wq8MSUQWG4XhmlTG4OFkrV_0KeU53Y2vXUXOQ,31616
 rtctools/optimization/goal_programming_mixin_base.py,sha256=MOXNAlDBOvsPgWMY-D2DUQX2HcOGfFw-bvOmZSiwepk,39951
 rtctools/optimization/homotopy_mixin.py,sha256=cgRPL-Ag9kd4iJQMbgKrRok-BUaRQwVJSCiAw_-1eck,6782
 rtctools/optimization/initial_state_estimation_mixin.py,sha256=CasRmqWVtyEpc4DwWcvpEcHBX7y0jsFERg5MSVb2FUo,3126
-rtctools/optimization/io_mixin.py,sha256=QkA9TxbMjlGn79WxuMLQyE9yIS-jBSJFLjSn9lkuqdI,11781
+rtctools/optimization/io_mixin.py,sha256=ZvltLXl1UON_GzlPVfkuvZvM2DUsz71B4HPVDoOSMgg,11817
 rtctools/optimization/linearization_mixin.py,sha256=ZG7553zowwSgl9Roe2yc24cp0DlqKkb2cmImGnaVGt0,1019
 rtctools/optimization/linearized_order_goal_programming_mixin.py,sha256=Aws3b0rnL-t8Bp_KOI9TbqqcuLb5ofSKKQMYjtUtLS0,8736
 rtctools/optimization/min_abs_goal_programming_mixin.py,sha256=kom9pV7Th5N31Adoc9RZRlQTcfqIzwui0PDe5AQnYuU,13293
 rtctools/optimization/modelica_mixin.py,sha256=f8bdeQB5jvlAggfwU4G7WSaT-ityy8D8Ckhi1mpJekA,16202
 rtctools/optimization/netcdf_mixin.py,sha256=fqhQSiSARQ4l6lwqp6ZDQ-SuIAeMPkQ69NcFnvk97C4,7259
-rtctools/optimization/optimization_problem.py,sha256=TsGZIC5yJFXQbiPXxlRWqhRoBVO7RWGRrMm5LdUFuTo,41817
+rtctools/optimization/optimization_problem.py,sha256=p0Tq2gj9sX9tOmMz9n3igXvrI822-lHeu1Tl31n3tg8,43078
 rtctools/optimization/pi_mixin.py,sha256=0sp0y_GT0BB5Mrv6WSDNIgNUz63mbfVxNPW3LDU7zw4,10785
 rtctools/optimization/single_pass_goal_programming_mixin.py,sha256=LxLquZYAnhR5wV39S3cgL3jKKQi4C3n6i0K55DETSdc,25126
 rtctools/optimization/timeseries.py,sha256=W2xYBZRZxKgOQ0aW_le5NDbXOBbokCeK-mjSUUa_EVs,1753
@@ -41,9 +41,9 @@ rtctools/simulation/csv_mixin.py,sha256=SIggsf7lfml3iWyhFSzCSCdxLt86ElluJQYxPYUk
 rtctools/simulation/io_mixin.py,sha256=DizXxYg3MhOqyYXdHVlF9rLTfOo_aXc59Jh_hzGcgkc,6163
 rtctools/simulation/pi_mixin.py,sha256=6uvqJZweP7wvEbiPmHMnOldG7_kvtqrdFVme0LVOVCo,9048
 rtctools/simulation/simulation_problem.py,sha256=FOP0JysrEccjbDevwN-qsD4IXtVZHV6BGP3Tmn9RhNM,35345
-rtc_tools-2.5.1rc1.dist-info/COPYING.LESSER,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
-rtc_tools-2.5.1rc1.dist-info/METADATA,sha256=flvIFJsthGRXkpUsqmZChkhF246kUaH0X5bsM5qf9Ao,1443
-rtc_tools-2.5.1rc1.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-rtc_tools-2.5.1rc1.dist-info/entry_points.txt,sha256=-x622IB_l1duw2M6t6syfQ4yzOiQTp0IZxKGcYRgWgk,151
-rtc_tools-2.5.1rc1.dist-info/top_level.txt,sha256=pnBrb58PFPd1kp1dqa-JHU7R55h3alDNJIJnF3Jf9Dw,9
-rtc_tools-2.5.1rc1.dist-info/RECORD,,
+rtc_tools-2.5.2a2.dist-info/COPYING.LESSER,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+rtc_tools-2.5.2a2.dist-info/METADATA,sha256=Fj09TM-bI_B0APYwcNWSEygJfnT4iB4IstUXpf62bQw,1454
+rtc_tools-2.5.2a2.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+rtc_tools-2.5.2a2.dist-info/entry_points.txt,sha256=-x622IB_l1duw2M6t6syfQ4yzOiQTp0IZxKGcYRgWgk,151
+rtc_tools-2.5.2a2.dist-info/top_level.txt,sha256=pnBrb58PFPd1kp1dqa-JHU7R55h3alDNJIJnF3Jf9Dw,9
+rtc_tools-2.5.2a2.dist-info/RECORD,,

rtctools/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2022-12-08T16:06:43+0000",
+ "date": "2023-03-21T15:45:07+0100",
  "dirty": false,
  "error": null,
- "full-revisionid": "3f949d10da42fb1aa8b9888f742771dd50947494",
- "version": "2.5.1rc1"
+ "full-revisionid": "51c2d6cf97df52e8a6790dc74aa9ec0866fc5a5c",
+ "version": "2.5.2a2"
 }
 '''  # END VERSION_JSON
 

rtctools/data/pi.py

@@ -732,14 +732,6 @@ class Timeseries:
         if self.__binary:
             f = io.open(self.binary_path, 'wb')
 
-        if self.timezone is not None:
-            timezone = self.__xml_root.find('pi:timeZone', ns)
-            if timezone is None:
-                timezone = ET.Element('{%s}' % (ns['pi'], ) + 'timeZone')
-                # timeZone has to be the first element according to the schema
-                self.__xml_root.insert(0, timezone)
-            timezone.text = str(self.timezone)
-
         if self.make_new_file:
             # Force reinitialization in case write() is called more than once
             self.__reset_xml_tree()
@@ -753,6 +745,14 @@ class Timeseries:
                         ensemble_member=ensemble_member, miss_val=-999, unit=unit)
 
         for ensemble_member in range(len(self.__values)):
+            if self.timezone is not None:
+                timezone = self.__xml_root.find('pi:timeZone', ns)
+                if timezone is None:
+                    timezone = ET.Element('{%s}' % (ns['pi'],) + 'timeZone')
+                    # timeZone has to be the first element according to the schema
+                    self.__xml_root.insert(0, timezone)
+                timezone.text = str(self.timezone)
+
             for series in self.__xml_root.findall('pi:series', ns):
                 header = series.find('pi:header', ns)
 

rtctools/optimization/collocated_integrated_optimization_problem.py

@@ -227,7 +227,7 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
 
         if self.integrated_states:
             warnings.warn("Integrated states are deprecated and support will be removed in a future version.",
-                          FutureWarning)
+                          FutureWarning, stacklevel=1)
 
         # Variables that are integrated states are not yet allowed to have size > 1
         for variable in self.integrated_states:
@@ -442,7 +442,8 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
         # Establish integrator theta
         theta = self.theta
         if theta < 1:
-            warnings.warn("Explicit collocation is deprecated and will be removed in a future version.", FutureWarning)
+            warnings.warn("Explicit collocation is deprecated and will be removed in a future version.",
+                          FutureWarning, stacklevel=1)
 
         # Set CasADi function options
         options = self.solver_options()
@@ -1326,7 +1327,8 @@ class CollocatedIntegratedOptimizationProblem(OptimizationProblem, metaclass=ABC
                             ca.repmat(np.nan, len(self.path_variables)),
                             ca.repmat(np.nan, len(self.__extra_constant_inputs))),
                          ca.repmat(np.nan, len(self.extra_variables))])
-                    delayed_feedback_history[i, :] = history_delayed_feedback_res
+                    delayed_feedback_history[i, :] = [
+                        float(val) for val in history_delayed_feedback_res]
 
                 initial_delayed_feedback = delayed_feedback_function.call(
                     self.__func_initial_inputs[ensemble_member], False, True)

rtctools/optimization/csv_lookup_table_mixin.py

@@ -293,6 +293,11 @@ class CSVLookupTableMixin(OptimizationProblem):
                 curve_name, *curvefit_options))
             return tuple(curvefit_options)
 
+        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))
         # Read CSV files
         logger.info(
             "CSVLookupTableMixin: Generating Splines from lookup table data.")
@@ -365,6 +370,7 @@ class CSVLookupTableMixin(OptimizationProblem):
                 symbols = [ca.SX.sym(inputs[0])]
                 if not valid_cache:
                     function = ca.Function('f', symbols, [BSpline1D(*tck)(symbols[0])])
+                check_lookup_table(output)
                 self.__lookup_tables[output] = LookupTable(symbols, function, tck)
 
             elif len(csvinput.dtype.names) == 3:
@@ -400,6 +406,7 @@ class CSVLookupTableMixin(OptimizationProblem):
                 symbols = [ca.SX.sym(inputs[0]), ca.SX.sym(inputs[1])]
                 if not valid_cache:
                     function = ca.Function('f', symbols, [BSpline2D(*tck)(symbols[0], symbols[1])])
+                check_lookup_table(output)
                 self.__lookup_tables[output] = LookupTable(symbols, function, tck)
 
             else:

rtctools/optimization/goal_programming_mixin.py

@@ -563,7 +563,7 @@ class GoalProgrammingMixin(_GoalProgrammingMixinBase):
             self.pre()
 
         # Group goals into subproblems
-        subproblems = []
+        self.subproblems = []
         goals = self.goals()
         path_goals = self.path_goals()
 
@@ -580,7 +580,7 @@ class GoalProgrammingMixin(_GoalProgrammingMixinBase):
         priorities = {int(goal.priority) for goal in itertools.chain(goals, path_goals) if not goal.is_empty}
 
         for priority in sorted(priorities):
-            subproblems.append((
+            self.subproblems.append((
                 priority,
                 [goal for goal in goals if int(goal.priority) == priority and not goal.is_empty],
                 [goal for goal in path_goals if int(goal.priority) == priority and not goal.is_empty]))
@@ -605,7 +605,7 @@ class GoalProgrammingMixin(_GoalProgrammingMixinBase):
         self.__results_are_current = False
         self.__original_constant_input_keys = {}
         self.__original_parameter_keys = {}
-        for i, (priority, goals, path_goals) in enumerate(subproblems):
+        for i, (priority, goals, path_goals) in enumerate(self.subproblems):
             logger.info("Solving goals at priority {}".format(priority))
 
             # Call the pre priority hook

rtctools/optimization/io_mixin.py

@@ -310,5 +310,6 @@ class IOMixin(OptimizationProblem, metaclass=ABCMeta):
         Deprecated, use `io.reference_datetime` and `io.datetimes`, or override behavior using
         :py:meth:`OptimizationProblem.times` and/or :py:attr:`OptimizationProblem.initial_time`.
         """
-        warnings.warn('get_forecast_index() is deprecated and will be removed in the future', FutureWarning)
+        warnings.warn('get_forecast_index() is deprecated and will be removed in the future',
+                      FutureWarning, stacklevel=1)
         return bisect.bisect_left(self.io.datetimes, self.io.reference_datetime)

rtctools/optimization/optimization_problem.py

@@ -155,12 +155,34 @@ class OptimizationProblem(DataStoreAccessor, metaclass=ABCMeta):
 
         success, log_level = self.solver_success(self.__solver_stats, log_solver_failure_as_error)
 
+        return_status = self.__solver_stats['return_status']
+        if 'secondary_return_status' in self.__solver_stats:
+            return_status = "{}: {}".format(return_status, self.__solver_stats['secondary_return_status'])
+        wall_clock_time = "elapsed time not read"
+        if 't_wall_total' in self.__solver_stats:
+            wall_clock_time = "{} seconds".format(self.__solver_stats['t_wall_total'])
+        elif 't_wall_solver' in self.__solver_stats:
+            wall_clock_time = "{} seconds".format(self.__solver_stats['t_wall_solver'])
+
         if success:
-            logger.log(log_level, "Solver succeeded with status {}".format(
-                self.__solver_stats['return_status']))
+            logger.log(log_level, "Solver succeeded with status {} ({}).".format(
+                return_status, wall_clock_time))
         else:
-            logger.log(log_level, "Solver failed with status {}".format(
-                self.__solver_stats['return_status']))
+            try:
+                ii = [y[0] for y in self.loop_over_error].index(self.priority)
+                loop_error_indicator = self.loop_over_error[ii][1]
+                try:
+                    loop_error = self.loop_over_error[ii][2]
+                    if loop_error_indicator and loop_error in return_status:
+                        log_level = logging.INFO
+                except IndexError:
+                    if loop_error_indicator:
+                        log_level = logging.INFO
+                logger.log(log_level, "Solver succeeded 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))
 
         # Do any postprocessing
         if postprocessing: