Merge pull request #76 from MiraGeoscience/GEOPY-2149

GEOPY-2149: Rename params to options

Author: domfournier

plate_simulation/driver.py

@@ -28,7 +28,7 @@
 from plate_simulation.models.events import Anomaly, Erosion, Overburden
 from plate_simulation.models.plates import Plate
 from plate_simulation.models.series import DikeSwarm, Geology
-from plate_simulation.params import PlateSimulationParams
+from plate_simulation.options import PlateSimulationOptions
 from plate_simulation.utils import replicate
 
 
@@ -44,7 +44,7 @@ class PlateSimulationDriver:
     :param survey: Survey object for the simulation
     """
 
-    def __init__(self, params: PlateSimulationParams):
+    def __init__(self, params: PlateSimulationOptions):
         self.params = params
 
         self._surfaces: list[Surface] | None = None
@@ -305,7 +305,7 @@ def start(ifile: str | Path | InputFile):
             return None
 
         with ifile.geoh5.open(mode="r+"):  # type: ignore
-            params = PlateSimulationParams.build(ifile)
+            params = PlateSimulationOptions.build(ifile)
 
             return PlateSimulationDriver(params).run()
 

plate_simulation/mesh/params.py plate_simulation/mesh/options.pyplate_simulation/mesh/params.py renamed to plate_simulation/mesh/options.py

@@ -14,7 +14,7 @@
 from pydantic import BaseModel
 
 
-class MeshParams(BaseModel):
+class MeshOptions(BaseModel):
     """Core parameters for octree mesh creation."""
 
     u_cell_size: float

plate_simulation/models/params.py plate_simulation/models/options.pyplate_simulation/models/params.py renamed to plate_simulation/models/options.py

@@ -23,7 +23,7 @@
 T = TypeVar("T")
 
 
-class PlateParams(BaseModel):
+class PlateOptions(BaseModel):
     """
     Parameters describing an anomalous plate.
 
@@ -72,7 +72,7 @@ class PlateParams(BaseModel):
     @field_validator("reference_surface", "reference_type", mode="before")
     @classmethod
     def none_to_default(cls, value: T | None, info: ValidationInfo) -> T:
-        return value or cls.model_fields[info.field_name].default  # type: ignore
+        return value or cls.model_fields[info.field_name].default  # pylint: disable=unsubscriptable-object
 
     @model_validator(mode="after")
     def single_plate(self):
@@ -132,7 +132,7 @@ def _get_z(self, surface: Points, offset: float = 0.0) -> float:
         return z
 
 
-class OverburdenParams(BaseModel):
+class OverburdenOptions(BaseModel):
     """
     Parameters for the overburden layer.
 
@@ -144,7 +144,7 @@ class OverburdenParams(BaseModel):
     overburden: float
 
 
-class ModelParams(BaseModel):
+class ModelOptions(BaseModel):
     """
     Parameters for the blackground + overburden and plate model.
 
@@ -158,5 +158,5 @@ class ModelParams(BaseModel):
 
     name: str
     background: float
-    overburden: OverburdenParams
-    plate: PlateParams
+    overburden: OverburdenOptions
+    plate: PlateOptions

plate_simulation/models/plates.py

@@ -18,7 +18,7 @@
 from geoh5py.ui_json.utils import fetch_active_workspace
 from geoh5py.workspace import Workspace
 
-from plate_simulation.models.params import PlateParams
+from plate_simulation.models.options import PlateOptions
 
 
 class Plate:
@@ -31,7 +31,7 @@ class Plate:
 
     def __init__(
         self,
-        params: PlateParams,
+        params: PlateOptions,
         center_x: float = 0.0,
         center_y: float = 0.0,
         center_z: float = 0.0,

plate_simulation/params.py plate_simulation/options.pyplate_simulation/params.py renamed to plate_simulation/options.py

@@ -34,8 +34,8 @@
 )
 
 from . import assets_path
-from .mesh.params import MeshParams
-from .models.params import ModelParams
+from .mesh.options import MeshOptions
+from .models.options import ModelOptions
 
 
 PARAM_MAP = {
@@ -49,7 +49,7 @@
 }
 
 
-class PlateSimulationParams(BaseData):
+class PlateSimulationOptions(BaseData):
     """
     Parameters for the plate simulation driver.
 
@@ -67,8 +67,8 @@ class PlateSimulationParams(BaseData):
     run_command: ClassVar[str] = "plate_simulation.driver"
     out_group: UIJsonGroup | None = None
 
-    mesh: MeshParams
-    model: ModelParams
+    mesh: MeshOptions
+    model: ModelOptions
     simulation: SimPEGGroup
 
     def simulation_parameters(self) -> BaseForwardOptions:

tests/models/events_test.py

@@ -12,7 +12,7 @@
 from geoh5py.objects import Surface
 
 from plate_simulation.models.events import Anomaly, Deposition, Erosion, Overburden
-from plate_simulation.models.params import PlateParams
+from plate_simulation.models.options import PlateOptions
 from plate_simulation.models.plates import Plate
 
 from . import get_topo_mesh
@@ -79,7 +79,7 @@ def test_overburden(tmp_path):
 def test_anomaly(tmp_path):
     with Workspace(tmp_path / "test.geoh5") as workspace:
         _, octree = get_topo_mesh(workspace)
-        params = PlateParams(
+        params = PlateOptions(
             name="my plate",
             plate=10.0,
             elevation=-1.5,

tests/models/params_test.py

@@ -11,12 +11,12 @@
 from geoh5py import Workspace
 from geoh5py.objects import Points, Surface
 
-from plate_simulation.models.params import PlateParams
+from plate_simulation.models.options import PlateOptions
 
 
 def test_plate_params(tmp_path):
     workspace = Workspace(tmp_path / "test.geoh5")
-    params = PlateParams(
+    params = PlateOptions(
         name="my plate",
         plate=1.0,
         width=20.0,
@@ -57,7 +57,7 @@ def test_plate_params(tmp_path):
 
 
 def test_plate_params_empty_reference():
-    params = PlateParams(
+    params = PlateOptions(
         name="my plate",
         plate=1.0,
         width=20.0,

tests/models/plates_test.py

@@ -11,7 +11,7 @@
 from geoapps_utils.utils.transformations import rotate_xyz
 from geoh5py import Workspace
 
-from plate_simulation.models.params import PlateParams
+from plate_simulation.models.options import PlateOptions
 from plate_simulation.models.plates import Plate
 
 
@@ -24,7 +24,7 @@ def are_collocated(pts1, pts2):
 
 
 def vertical_east_striking_plate(workspace):
-    params = PlateParams(
+    params = PlateOptions(
         name="my plate",
         plate=1.0,
         elevation=0.0,
@@ -73,7 +73,7 @@ def test_dipping_plates_all_quadrants(tmp_path):
 
     for dip_direction in np.arange(0.0, 361.0, 45.0):
         for dip in [20.0, 70.0]:
-            params = PlateParams(
+            params = PlateOptions(
                 name=f"plate dipping {dip} at {dip_direction}",
                 plate=1.0,
                 elevation=0.0,

tests/runtest/driver_test.py

@@ -19,9 +19,9 @@
 from simpeg_drivers.potential_fields.gravity.options import GravityForwardOptions
 
 from plate_simulation import assets_path
-from plate_simulation.driver import PlateSimulationDriver, PlateSimulationParams
-from plate_simulation.mesh.params import MeshParams
-from plate_simulation.models.params import ModelParams
+from plate_simulation.driver import PlateSimulationDriver, PlateSimulationOptions
+from plate_simulation.mesh.options import MeshOptions
+from plate_simulation.models.options import ModelOptions
 
 from . import get_survey, get_topography
 
@@ -191,7 +191,7 @@ def test_plate_simulation_params_from_input_file(tmp_path):
         ifile.data["reference_surface"] = "topography"
         ifile.data["reference_type"] = "mean"
 
-        params = PlateSimulationParams.build(ifile)
+        params = PlateSimulationOptions.build(ifile)
         assert isinstance(params.simulation, SimPEGGroup)
 
         simulation_parameters = params.simulation_parameters()
@@ -204,7 +204,7 @@ def test_plate_simulation_params_from_input_file(tmp_path):
         )
         assert simulation_parameters.data_object.uid == survey.uid
 
-        assert isinstance(params.mesh, MeshParams)
+        assert isinstance(params.mesh, MeshOptions)
         assert params.mesh.u_cell_size == 10.0
         assert params.mesh.v_cell_size == 10.0
         assert params.mesh.w_cell_size == 10.0
@@ -214,7 +214,7 @@ def test_plate_simulation_params_from_input_file(tmp_path):
         assert params.mesh.minimum_level == 8
         assert not params.mesh.diagonal_balance
 
-        assert isinstance(params.model, ModelParams)
+        assert isinstance(params.model, ModelOptions)
         assert params.model.name == "test_gravity_plate_simulation"
         assert params.model.background == 1000.0
         assert params.model.overburden.thickness == 50.0

tests/runtest/gravity_test.py

@@ -15,9 +15,13 @@
 from simpeg_drivers.constants import default_ui_json
 
 from plate_simulation.driver import PlateSimulationDriver
-from plate_simulation.mesh.params import MeshParams
-from plate_simulation.models.params import ModelParams, OverburdenParams, PlateParams
-from plate_simulation.params import PlateSimulationParams
+from plate_simulation.mesh.options import MeshOptions
+from plate_simulation.models.options import (
+    ModelOptions,
+    OverburdenOptions,
+    PlateOptions,
+)
+from plate_simulation.options import PlateSimulationOptions
 
 from . import get_survey, get_topography
 
@@ -27,7 +31,7 @@ def test_gravity_plate_simulation(tmp_path):
         topography = get_topography(ws)
         survey = get_survey(ws, 10, 10)
 
-        mesh_params = MeshParams(
+        mesh_params = MeshOptions(
             u_cell_size=10.0,
             v_cell_size=10.0,
             w_cell_size=10.0,
@@ -36,9 +40,9 @@ def test_gravity_plate_simulation(tmp_path):
             max_distance=200.0,
         )
 
-        overburden_params = OverburdenParams(thickness=50.0, overburden=0.2)
+        overburden_params = OverburdenOptions(thickness=50.0, overburden=0.2)
 
-        plate_params = PlateParams(
+        plate_params = PlateOptions(
             name="plate",
             plate=0.5,
             elevation=-250.0,
@@ -50,7 +54,7 @@ def test_gravity_plate_simulation(tmp_path):
             reference="center",
         )
 
-        model_params = ModelParams(
+        model_params = ModelOptions(
             name="density",
             background=0.0,
             overburden=overburden_params,
@@ -68,7 +72,7 @@ def test_gravity_plate_simulation(tmp_path):
         gravity_inversion = SimPEGGroup.create(ws)
         gravity_inversion.options = options
 
-        params = PlateSimulationParams(
+        params = PlateSimulationOptions(
             title="test",
             run_command="run",
             geoh5=ws,