rtc-tools-interface 0.10.1__tar.gz → 0.10.2a2__tar.gz

{rtc-tools-interface-0.10.1/rtc_tools_interface.egg-info → rtc_tools_interface-0.10.2a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: rtc-tools-interface
-Version: 0.10.1
+Name: rtc_tools_interface
+Version: 0.10.2a2
 Summary: Toolbox for user interfaces for RTC-Tools
 Home-page: UNKNOWN
 Author: Deltares

{rtc-tools-interface-0.10.1 → rtc_tools_interface-0.10.2a2}/README.md

@@ -70,28 +70,30 @@ where $w$ is equal to the `weight` (default is 1), $r$ is equal to the `order` (
 For the range goal, rtc-tools adds the following equation to the objective function of the specified priority
 $$w\sum_t \epsilon_t^r $$
 and the following constraints
-$$  
-\begin{aligned}
-g_{low}(\epsilon_t) \leq &x_t \leq g_{up}(\epsilon_t) \quad &\forall t\\
- 0 \leq &\epsilon_t \leq 1 \quad &\forall t 
-\end{aligned}
-$$
+
+$$g_{low}(\epsilon_t) \leq x_t \leq g_{up}(\epsilon_t) \quad \forall t $$
+
+$$0 \leq \epsilon_t \leq 1 \quad \forall t $$
+
 where
-$$
-\begin{aligned}
-g_{low}(\epsilon_t) &:= (1-\epsilon_t) m_{t,target} + \epsilon_t m \\
-g_{up}(\epsilon_t)  &:= (1-\epsilon_t) M_{t,target} + \epsilon_t M 
-\end{aligned}
-$$
-and $w$ is equal to the `weight` (default is 1), $r$ is equal to the `order` (default is 2), $t$ the timestep, $x$ the selected `state`, $m_{target}$ and $M_{target}$ the lower and upper targets (`target_min` and `target_max`), $m$ and $M$ the actual bounds of $x$ (`function_min` and `function_max`). The auxiliary variable $\epsilon$ is automatically created by rtc-tools. In loose terms, the range goal tries to archieve
-$$ m_{t,target} \leq x_t \leq M_{t,target} \quad \forall t$$
+
+$$g_{low}(\epsilon_t) = (1-\epsilon_t) m_{t,target} + \epsilon_t m $$
+
+$$g_{up}(\epsilon_t)  = (1-\epsilon_t) M_{t,target} + \epsilon_t M $$
+
+and $w$ is equal to the `weight` (default is 1), $r$ is equal to the `order` (default is 2), $t$ the timestep, $x$ the selected `state`, $m_{target}$ and $M_{target}$ the lower and upper targets (`target_min` and `target_max`), $m$ and $M$ the actual bounds of $x$ (`function_min` and `function_max`). The auxiliary variable $\epsilon$ is automatically created by rtc-tools. 
+
+In loose terms, the range goal tries to archieve
+
+$$m_{t,target} \leq x_t \leq M_{t,target} \quad \forall t$$
+
 by minimizing, if any, the sum of exceedances for the timesteps. For more details on the range goal, see [Read the Docs](https://rtc-tools.readthedocs.io/en/latest/optimization/goal_programming/goals.html) of rtc-tools.
 
 
 #### range_rate_of_change
 The range_rate_of_change goal can be used to set a target range on ramp rate. Like the range goal, one needs to set the `target_min` and `target_max` for that. **Importantly** for the range_rate_of_change goal, the supplied values are relative to the nominal of the function. So supplying a `target_max` of `10` corresponds to the aim of having a maximum increase per timestep of 10% * `nominal`, where the nominal automatically set to `maximum rate of change`/2 or specified manually. To formulate the target of having a maximum increase and decrease by of 10% per timestep, one would set the `target_min` to `-10` and the `target_max` to `10`.
 
-The equations for the range_rate_of_change goal are almost the same as for the range goal, which can be found above. The only difference is that $x_t$ is replaced by $der(x_t)$.
+The equations for the range_rate_of_change goal are almost the same as for the range goal, which can be found above. The only difference is that $x_t$ is replaced by the derivative of $x$ with respect to $t$, calculated as $\frac{x_t - x_{t-1}}{\Delta t}$.  
 
 ### Example goal table
 See the table below for an example content of the `goal_table.csv`.

{rtc-tools-interface-0.10.1 → rtc_tools_interface-0.10.2a2/rtc_tools_interface.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rtc-tools-interface
-Version: 0.10.1
+Version: 0.10.2a2
 Summary: Toolbox for user interfaces for RTC-Tools
 Home-page: UNKNOWN
 Author: Deltares

{rtc-tools-interface-0.10.1 → rtc_tools_interface-0.10.2a2}/rtctools_interface/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-06-04T10:02:27+0200",
+ "date": "2025-10-30T09:45:54+0100",
  "dirty": false,
  "error": null,
- "full-revisionid": "33cba7abbd05364334aabef715ce319b398ff945",
- "version": "0.10.1"
+ "full-revisionid": "dcc43a518f9d2672d43280e14083500fb85225cb",
+ "version": "0.10.2a2"
 }
 '''  # END VERSION_JSON
 

{rtc-tools-interface-0.10.1 → rtc_tools_interface-0.10.2a2}/rtctools_interface/plotting/subplot_classes.py

@@ -200,10 +200,35 @@ class SubplotMatplotlib(SubplotBase):
 
     def plot_dashed_line(self, xarray, yarray, label, color="red"):
         """Given the input and output array, add dashed line plot to the subplot."""
-        self.axis.plot(xarray, yarray, "--", label=label, color=color)
+        # Create step data for implicit timesteps:
+        step_x = []
+        step_y = []
+        for i in range(len(xarray)):
+            if i == 0:
+                step_x.append(xarray[i])
+                step_y.append(yarray[i])
+            else:
+                step_x.append(xarray[i-1])
+                step_y.append(yarray[i])
+                step_x.append(xarray[i])
+                step_y.append(yarray[i])
+        self.axis.plot(step_x, step_y, "--", label=label, color=color)
 
     def plot_line(self, xarray, yarray, label, color=None, linewidth=None, linestyle=None):
-        self.axis.plot(xarray, yarray, label=label, color=color, linewidth=linewidth, linestyle=linestyle)
+        """Plot step line for implicit timesteps."""
+        # Create step data for implicit timesteps:
+        step_x = []
+        step_y = []
+        for i in range(len(xarray)):
+            if i == 0:
+                step_x.append(xarray[i])
+                step_y.append(yarray[i])
+            else:
+                step_x.append(xarray[i-1])
+                step_y.append(yarray[i])
+                step_x.append(xarray[i])
+                step_y.append(yarray[i])
+        self.axis.plot(step_x, step_y, label=label, color=color, linewidth=linewidth, linestyle=linestyle)
 
     def format_subplot(self):
         """Format the current axis and set legend and title."""
@@ -258,30 +283,66 @@ class SubplotPlotly(SubplotBase):
         return color_mapping.get(color, color)
 
     def plot_dashed_line(self, xarray, yarray, label, color="red"):
-        """Given the input and output array, add dashed line plot to the subplot."""
+        """Given the input and output array, add dashed step line plot to the subplot."""
+        # Create step data for plotly by duplicating points
+        step_x = []
+        step_y = []
+
+        for i in range(len(xarray)):
+            if i == 0:
+                # First point - just add as is
+                step_x.append(xarray[i])
+                step_y.append(yarray[i])
+            else:
+                # Add horizontal line from previous time to current time at previous value
+                step_x.append(xarray[i-1])
+                step_y.append(yarray[i])
+                # Add vertical line at current time from previous to current value
+                step_x.append(xarray[i])
+                step_y.append(yarray[i])
+
         self.figure.add_trace(
             go.Scatter(
                 legendgroup=self.i_plot,
-                x=xarray,
-                y=yarray,
+                x=step_x,
+                y=step_y,
                 name=label,
-                line={"color": self.map_color_code(color), "dash": "dot"},
+                line={"color": self.map_color_code(color), "dash": "dot", "shape": "hv"},
             ),
             row=self.row_num,
             col=self.col_num,
         )
 
     def plot_line(self, xarray, yarray, label, color=None, linewidth=None, linestyle=None):
+        """Plot step line for implicit timesteps."""
         linewidth = float(linewidth) * 1.3 if linewidth else linewidth
         linestyle = "dot" if linestyle == "dotted" else linestyle
+
+        # Create step data for plotly by duplicating points
+        step_x = []
+        step_y = []
+
+        for i in range(len(xarray)):
+            if i == 0:
+                # First point - just add as is
+                step_x.append(xarray[i])
+                step_y.append(yarray[i])
+            else:
+                # Add horizontal line from previous time to current time at previous value
+                step_x.append(xarray[i-1])
+                step_y.append(yarray[i])
+                # Add vertical line at current time from previous to current value
+                step_x.append(xarray[i])
+                step_y.append(yarray[i])
+
         self.figure.add_trace(
             go.Scatter(
                 legendgroup=self.i_plot,
                 legendgrouptitle_text=self.subplot_title,
-                x=xarray,
-                y=yarray,
+                x=step_x,
+                y=step_y,
                 name=label,
-                line={"width": linewidth, "dash": linestyle, "color": color},
+                line={"width": linewidth, "dash": linestyle, "color": color, "shape": "hv"},
             ),
             row=self.row_num,
             col=self.col_num,

{rtc-tools-interface-0.10.1 → rtc_tools_interface-0.10.2a2}/rtctools_interface/utils/results_collection.py

@@ -160,7 +160,11 @@ class PlottingBaseMixin(ReadGoalsMixin):
     def create_plot_data_and_config(self, base_goals: list) -> PlotDataAndConfig:
         """Create the PlotDataAndConfig dict."""
         prio_independent_data: PrioIndependentData = {
-            "io_datetimes": self.io.datetimes,
+            "io_datetimes": [
+                dt
+                for idx, dt in enumerate(self.io.datetimes)
+                if self.io.times_sec[idx] in self.times()
+            ],
             "times": self.times(),
             "base_goals": base_goals,
         }

{rtc-tools-interface-0.10.1 → rtc_tools_interface-0.10.2a2}/setup.py

@@ -4,7 +4,7 @@ import versioneer
 
 
 setup(
-    name="rtc-tools-interface",
+    name="rtc_tools_interface",
     version=versioneer.get_version(),
     maintainer="Deltares",
     packages=find_packages("."),