Merge pull request #1629 from knutfrode/dev

[run-ex] New mechanism to skip environment variables based on conditi…

Author: knutfrode

opendrift/models/basemodel/__init__.py

@@ -241,6 +241,8 @@ def __init__(self,
         # List to store GeoJSON dicts of seeding commands
         self.seed_geojson = []
 
+        self.required_variables = self.required_variables.copy()  # Avoid modifying the class variable
+
         self.env = Environment(self.required_variables, self._config)
 
         # Make copies of dictionaries so that they are private to each instance
@@ -1807,6 +1809,16 @@ def run(self,
         if self.steps_calculation >= 1:
             self.steps_calculation = 0
 
+        ###################################################################################
+        # Remove variables from required_variables based on configuration and conditionals
+        ###################################################################################
+        for vn, var in self.required_variables.copy().items():
+            if 'skip_if' in var:
+                skip = self.evaluate_conditional(*var['skip_if'])
+                if skip is True:
+                    logger.info(f'Skipping environment variable {vn} because of condition {var["skip_if"]}')
+                    self.required_variables.pop(vn)
+
         ########################
         # Simulation time step
         ########################
@@ -4755,3 +4767,34 @@ def center_of_gravity(self, onlysurface=False):
     def gui_postproc(self):
         '''To be overloaded by subclasses'''
         pass
+
+    def evaluate_conditional(self, key, operator, value):
+        """Evaluate a condition as True or False
+
+        This can be used to:
+        - skip required_variables that are not required, based on config setting
+        - store previous value of element property or environment variable, based on config setting
+        - disable a config setting based on another setting (for dynamic menus)
+
+        key: config key string
+        operator: one from operator_map below
+        value: the provided value to be matched with operator against actual config setting
+
+        Returns: True or False
+        """
+
+        operator_map = { 
+            '==': lambda x, y: x == y,
+            '!=': lambda x, y: x != y,
+            '<': lambda x, y: x < y,
+            '<=': lambda x, y: x <= y,
+            '>': lambda x, y: x > y,
+            '>=': lambda x, y: x >= y,
+            'is': lambda x, y: x is y,
+            'is not': lambda x, y: x is not y,
+        }
+        
+        # Presently assuming that key is a config key
+        key = self.get_config(key)
+
+        return operator_map[operator](key, value)

opendrift/models/oceandrift.py

@@ -73,12 +73,16 @@ class OceanDrift(OpenDriftSimulation):
         'sea_surface_height': {'fallback': 0},
         'x_wind': {'fallback': 0},
         'y_wind': {'fallback': 0},
-        'upward_sea_water_velocity': {'fallback': 0},
+        'upward_sea_water_velocity': {'fallback': 0,
+            'skip_if': ['drift:vertical_advection', 'is', False]},
         'ocean_vertical_diffusivity': {'fallback': 0,
+             'skip_if': ['drift:vertical_mixing', 'is', False],
              'profiles': True},
         'sea_surface_wave_significant_height': {'fallback': 0},
-        'sea_surface_wave_stokes_drift_x_velocity': {'fallback': 0},
-        'sea_surface_wave_stokes_drift_y_velocity': {'fallback': 0},
+        'sea_surface_wave_stokes_drift_x_velocity': {'fallback': 0,
+            'skip_if': ['drift:stokes_drift', 'is', False]},
+        'sea_surface_wave_stokes_drift_y_velocity': {'fallback': 0,
+            'skip_if': ['drift:stokes_drift', 'is', False]},
         'sea_surface_wave_period_at_variance_spectral_density_maximum':
             {'fallback': 0},
         'sea_surface_wave_mean_period_from_variance_spectral_density_second_frequency_moment': {'fallback': 0},

tests/models/test_basemodel.py

@@ -10,7 +10,7 @@
 def test_logging(tmpdir, capsys):
     # Accepting small variations in log output,
     # depending on machine, and from which folder test is run
-    accepted = (286, 289, 314) 
+    accepted = (278, 281)
 
     # Logging to console
     logfile = None