rtc-tools-interface 0.7.0b2__tar.gz → 0.7.0b3__tar.gz

{rtc-tools-interface-0.7.0b2 → rtc-tools-interface-0.7.0b3}/PKG-INFO

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

{rtc-tools-interface-0.7.0b2 → rtc-tools-interface-0.7.0b3}/rtc_tools_interface.egg-info/PKG-INFO

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

{rtc-tools-interface-0.7.0b2 → rtc-tools-interface-0.7.0b3}/rtc_tools_interface.egg-info/SOURCES.txt

@@ -23,6 +23,7 @@ rtctools_interface/optimization/helpers/__init__.py
 rtctools_interface/optimization/helpers/statistics_mixin.py
 rtctools_interface/utils/__init__.py
 rtctools_interface/utils/plot_table_schema.py
+rtctools_interface/utils/read_goals_mixin.py
 rtctools_interface/utils/read_plot_table.py
 rtctools_interface/utils/results_collection.py
 rtctools_interface/utils/serialization.py

{rtc-tools-interface-0.7.0b2 → rtc-tools-interface-0.7.0b3}/rtctools_interface/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2023-11-28T12:55:40+0000",
+ "date": "2023-11-28T16:07:57+0000",
  "dirty": false,
  "error": null,
- "full-revisionid": "1f87ed16ad412023e2c23dede1dbb63eb64f9188",
- "version": "0.7.0b2"
+ "full-revisionid": "499d6e416027fec2a9b6dd1cc4d7249b30a41463",
+ "version": "0.7.0b3"
 }
 '''  # END VERSION_JSON
 

{rtc-tools-interface-0.7.0b2 → rtc-tools-interface-0.7.0b3}/rtctools_interface/optimization/goal_generator_mixin.py

@@ -2,13 +2,12 @@
 from pathlib import Path
 from typing import Dict, Union
 import logging
-import os
 import pandas as pd
 
 from rtctools_interface.optimization.base_goal import BaseGoal
 from rtctools_interface.optimization.goal_performance_metrics import get_performance_metrics
 from rtctools_interface.optimization.helpers.statistics_mixin import StatisticsMixin
-from rtctools_interface.optimization.read_goals import read_goals
+from rtctools_interface.utils.read_goals_mixin import ReadGoalsMixin
 
 logger = logging.getLogger("rtctools")
 
@@ -21,7 +20,7 @@ def write_performance_metrics(performance_metrics: Dict[str, pd.DataFrame], outp
         performance_metric_table.to_csv(output_path / f"{goal_id}.csv")
 
 
-class GoalGeneratorMixin(StatisticsMixin):
+class GoalGeneratorMixin(ReadGoalsMixin, StatisticsMixin):
     # TODO: remove pylint disable below once we have more public functions.
     # pylint: disable=too-few-public-methods
     """Add path goals as specified in the goal_table.
@@ -34,19 +33,10 @@ class GoalGeneratorMixin(StatisticsMixin):
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
-        self.goals_to_generate = kwargs.get("goals_to_generate", [])
-        self.read_from = kwargs.get("read_goals_from", "csv_table")
-        if not hasattr(self, "goal_table_file"):
-            self.goal_table_file = os.path.join(self._input_folder, "goal_table.csv")
-
-        self._goal_generator_path_goals = read_goals(
-            self.goal_table_file, path_goal=True, read_from=self.read_from, goals_to_generate=self.goals_to_generate
-        )
-        self._goal_generator_non_path_goals = read_goals(
-            self.goal_table_file, path_goal=False, read_from=self.read_from, goals_to_generate=self.goals_to_generate
-        )
-        self._all_goal_generator_goals = self._goal_generator_path_goals + self._goal_generator_non_path_goals
-
+        if not hasattr(self, "_all_goal_generator_goals"):
+            goals_to_generate = kwargs.get("goals_to_generate", [])
+            read_from = kwargs.get("read_goals_from", "csv_table")
+            self.load_goals(read_from, goals_to_generate)
         if self.calculate_performance_metrics:
             # A dataframe for each goal defined by the goal generator
             self._performance_metrics = {}

{rtc-tools-interface-0.7.0b2 → rtc-tools-interface-0.7.0b3}/rtctools_interface/optimization/plot_mixin.py

@@ -9,11 +9,13 @@ from rtctools_interface.utils.results_collection import PlottingBaseMixin
 logger = logging.getLogger("rtctools")
 
 
-class PlotMixin(StatisticsMixin, PlottingBaseMixin):
+class PlotMixin(PlottingBaseMixin, StatisticsMixin):
     """
     Class for plotting results.
     """
 
+    optimization_problem = True
+
     def priority_completed(self, priority: int) -> None:
         """Store priority-dependent results required for plotting."""
         timeseries_data = self.collect_timeseries_data(list(set(self.custom_variables + self.state_variables)))

rtc-tools-interface-0.7.0b3/rtctools_interface/utils/read_goals_mixin.py

@@ -0,0 +1,31 @@
+"""Mixin to read the goal table and store as class variables."""
+import os
+from typing import Literal, Optional
+
+from rtctools_interface.optimization.read_goals import read_goals
+
+
+class ReadGoalsMixin:
+    """Read the goal table either from the default or specified path."""
+
+    def load_goals(
+        self, read_from: Literal["csv_table", "passed_list"] = "csv_table", goals_to_generate: Optional[list] = None
+    ):
+        """Read goal table and store as instance variable."""
+        goals_to_generate = goals_to_generate if goals_to_generate else []
+        if not hasattr(self, "goal_table_file"):
+            self.goal_table_file = os.path.join(self._input_folder, "goal_table.csv")
+
+        if read_from == "csv_table" and os.path.isfile(self.goal_table_file) or read_from == "passed_list":
+            self._goal_generator_path_goals = read_goals(
+                self.goal_table_file, path_goal=True, read_from=read_from, goals_to_generate=goals_to_generate
+            )
+            self._goal_generator_non_path_goals = read_goals(
+                self.goal_table_file,
+                path_goal=False,
+                read_from=read_from,
+                goals_to_generate=goals_to_generate,
+            )
+            self._all_goal_generator_goals = self._goal_generator_path_goals + self._goal_generator_non_path_goals
+        else:
+            self._all_goal_generator_goals = []

{rtc-tools-interface-0.7.0b2 → rtc-tools-interface-0.7.0b3}/rtctools_interface/utils/results_collection.py

@@ -8,6 +8,7 @@ from typing import Dict, List, Optional
 
 import numpy as np
 from rtctools_interface.utils.plot_table_schema import PlotTableRow
+from rtctools_interface.utils.read_goals_mixin import ReadGoalsMixin
 
 from rtctools_interface.utils.serialization import deserialize, serialize
 from rtctools_interface.utils.read_plot_table import get_plot_config
@@ -94,7 +95,7 @@ def filter_plot_config(plot_config: list[PlotTableRow], all_goal_generator_goals
     return new_plot_config
 
 
-class PlottingBaseMixin:
+class PlottingBaseMixin(ReadGoalsMixin):
     """Base class for creating plots.
 
     Reads the plot table, if available the goal table, and contains functions to store all required data for plots."""
@@ -116,7 +117,13 @@ class PlottingBaseMixin:
         self.plot_config = get_plot_config(plot_table_file, plot_config_list, read_from)
 
         self.custom_variables = get_plot_variables(self.plot_config)
-        if hasattr(self, "_all_goal_generator_goals"):
+
+        if not hasattr(self, "_all_goal_generator_goals") and self.optimization_problem:
+            goals_to_generate = kwargs.get("goals_to_generate", [])
+            read_from = kwargs.get("read_goals_from", "csv_table")
+            self.load_goals(read_from, goals_to_generate)
+
+        if self.optimization_problem:
             all_goal_generator_goals = self._all_goal_generator_goals
             self.state_variables = list({base_goal.state for base_goal in all_goal_generator_goals})
         else: