Merge pull request #20 from GeoOcean/feature/wrappers

baseic wrappersss

Author: tausiaj

.gitignore

@@ -96,4 +96,5 @@ env.bak/
 venv.bak/
 
 # Local notebooks
-notebooks/
+notebooks/
+test_cases/

bluemath_tk/wrappers/_base_wrappers.py

@@ -0,0 +1,65 @@
+import os
+from typing import List
+from jinja2 import Environment, FileSystemLoader
+from abc import abstractmethod
+from ..core.models import BlueMathModel
+
+
+class BaseModelWrapper(BlueMathModel):
+    """
+    Base class for model wrappers.
+    """
+
+    @abstractmethod
+    def __init__(
+        self,
+        templates_dir: str,
+        templates_name: List[str],
+        model_parameters: dict,
+        output_dir: str,
+    ):
+        super().__init__()
+        self.templates_dir = templates_dir
+        self.templates_name = templates_name
+        self.model_parameters = model_parameters
+        self.output_dir = output_dir
+        self.env = Environment(loader=FileSystemLoader(self.templates_dir))
+
+    def build_cases_one_by_one(self):
+        num_cases = len(next(iter(self.model_parameters.values())))
+        for param, values in self.model_parameters.items():
+            if len(values) != num_cases:
+                raise ValueError(
+                    f"All parameters must have the same number of values in one_by_one mode, check {param}"
+                )
+        for case_num in range(num_cases):
+            case_folder = os.path.join(self.output_dir, f"{case_num:04}")
+            os.makedirs(case_folder, exist_ok=True)
+            case_context = {
+                param: values[case_num]
+                for param, values in self.model_parameters.items()
+            }
+            for template_name in self.templates_name:
+                self.render_file_from_template(
+                    template_name=template_name,
+                    context=case_context,
+                    output_filename=os.path.join(case_folder, template_name),
+                )
+
+    def build_cases(self, mode: str = "one_by_one"):
+        if mode == "one_by_one":
+            self.build_cases_one_by_one()
+
+    def render_file_from_template(
+        self, template_name: str, context: dict, output_filename: str = None
+    ):
+        template = self.env.get_template(name=template_name)
+        rendered_content = template.render(context)
+        if output_filename is None:
+            output_filename = os.path.join(self.output_dir, template_name)
+        with open(output_filename, "w") as f:
+            f.write(rendered_content)
+
+    @abstractmethod
+    def run_model(self, input_file):
+        pass

bluemath_tk/wrappers/swash.py bluemath_tk/wrappers/swash/__init__.pybluemath_tk/wrappers/swash.py renamed to bluemath_tk/wrappers/swash/__init__.py

@@ -0,0 +1,60 @@
+import subprocess
+from bluemath_tk.wrappers._base_wrappers import BaseModelWrapper
+
+
+class SwashModelWrapper(BaseModelWrapper):
+    """
+    Wrapper for the SWASH model.
+    https://swash.sourceforge.io/online_doc/swashuse/swashuse.html#input-and-output-files
+    """
+
+    default_parameters = {
+        "param1": "default_type1",
+    }
+
+    def __init__(
+        self,
+        templates_dir: str,
+        templates_name: dict,
+        model_parameters: dict,
+        output_dir: str,
+    ):
+        super().__init__(
+            templates_dir=templates_dir,
+            templates_name=templates_name,
+            model_parameters=model_parameters,
+            output_dir=output_dir,
+        )
+        self.set_logger_name(self.__class__.__name__)
+
+    def run_model(self, input_file):
+        # Implement the logic to run the SWASH model with the given input file
+        # For example, using subprocess to call the SWASH executable
+        result = subprocess.run(
+            ["swashrun", input_file], capture_output=True, text=True
+        )
+        return result.stdout, result.stderr
+
+
+# Usage example
+if __name__ == "__main__":
+    # Define the input parameters
+    templates_dir = (
+        "/home/tausiaj/GitHub-GeoOcean/BlueMath/bluemath_tk/wrappers/swash/templates/"
+    )
+    templates_name = ["input.sws"]
+    model_parameters = {
+        "vegetation_height": [1, 2, 3],
+    }
+    output_dir = "/home/tausiaj/GitHub-GeoOcean/BlueMath/test_cases/swash/"
+    # Create an instance of the SWASH model wrapper
+    swan_model = SwashModelWrapper(
+        templates_dir=templates_dir,
+        templates_name=templates_name,
+        model_parameters=model_parameters,
+        output_dir=output_dir,
+    )
+    # Build the input files
+    swan_model.build_cases()
+    # Run the model
+    # result = swan_model.run_model(input_file)

bluemath_tk/wrappers/swash/swash_wrapper.py

@@ -0,0 +1,59 @@
+$Project name '{{ project_name }}' '{{ case_id }}'
+PROJECT 'PEPE'
+$
+$Set water level
+SET LEVEL=1.0
+$
+$(1D-mode, flume) or (2D-mode, basin)
+MODE DYNanic ONED
+COORD CARTesian
+$Computational grid: geographic location, size, resolution and orientation
+CGRID 0 0 0 1399 0 1567 0
+$
+$Multi-layered mode
+VERT 1
+$
+$Reading bathymetry values from file
+INPGRID BOTTOM 0 0 0 1399 0 1.00 1
+READINP BOTTOM 1 'depth.bot' 1 0 FREE
+$
+$Reading vegetation values from file
+INPGRID NPLANTS 0 0 0 1399 0 1 1
+READINP NPLANTS 1 'plants.txt' 1 0 FREE
+$
+$Initial values for flow variables
+INIT ZERO
+$
+$Hydraulic boundary conditions
+BOU SIDE W CCW BTYPE WEAK CON SERIES 'waves.bnd'
+BOU SIDE E CCW BTYPE RADIATION 
+SPON E 10 
+$
+$Physics
+BREAK
+VEGETATION {{ vegetation_height }} 0.5009019570650376 1 1.0
+$Numerics
+NONHYDrostatic BOX 1. PREConditioner ILU
+$
+$Output quantities
+DISCRET UPW MOM
+DISCRET UPW UMOM H NONE
+DISCRET UPW WMOM H NONE
+DISCRET CORR
+$
+$Time integration
+TIMEI 0.1 0.5
+$
+QUANTITY XP hexp=10
+QUANT RUNUP delrp 0.01
+$
+CURVE 'line' 0 0 1399 1399 0
+TABLE 'line' HEAD 'output.tab' TSEC XP YP BOTL WATL QMAG OUTPUT 0 1 SEC
+$
+TABLE 'NOGRID' HEAD 'run.tab' TSEC RUNUP OUTPUT 0 1 SEC
+$
+$Starts computation
+TEST  1,0
+COMPUTE 000000.000 0.0168 SEC 002000.000
+STOP
+$