GEOPY-2127: Rename params modules to options

simpeg_drivers/components/data.py

@@ -18,7 +18,7 @@
     from geoh5py.workspace import Workspace
 
     from simpeg_drivers.components.meshes import InversionMesh
-    from simpeg_drivers.params import InversionBaseOptions
+    from simpeg_drivers.options import InversionBaseOptions
 
 from copy import deepcopy
 from re import findall

simpeg_drivers/components/factories/misfit_factory.py

@@ -19,7 +19,7 @@
 
     from simpeg_drivers.components.data import InversionData
     from simpeg_drivers.components.meshes import InversionMesh
-    from simpeg_drivers.params import BaseOptions
+    from simpeg_drivers.options import BaseOptions
 
 import numpy as np
 from geoh5py.objects import Octree

simpeg_drivers/components/factories/receiver_factory.py

@@ -20,7 +20,7 @@
 if TYPE_CHECKING:
     from geoapps_utils.driver.params import BaseParams
 
-    from simpeg_drivers.params import BaseOptions
+    from simpeg_drivers.options import BaseOptions
 
 import numpy as np
 from geoapps_utils.utils.transformations import rotate_xyz

simpeg_drivers/components/factories/simpeg_factory.py

@@ -18,7 +18,7 @@
 if TYPE_CHECKING:
     from geoapps_utils.driver.params import BaseParams
 
-    from simpeg_drivers.params import BaseOptions
+    from simpeg_drivers.options import BaseOptions
 
 # TODO Redesign simpeg factory to avoid pylint arguments-differ complaint
 

simpeg_drivers/components/factories/simulation_factory.py

@@ -20,7 +20,7 @@
 if TYPE_CHECKING:
     from geoapps_utils.driver.params import BaseParams
 
-    from simpeg_drivers.params import BaseOptions
+    from simpeg_drivers.options import BaseOptions
 
 from pathlib import Path
 

simpeg_drivers/components/factories/source_factory.py

@@ -29,7 +29,7 @@
 if TYPE_CHECKING:
     from geoapps_utils.driver.params import BaseParams
 
-    from simpeg_drivers.params import BaseOptions
+    from simpeg_drivers.options import BaseOptions
 
 
 class SourcesFactory(SimPEGFactory):

simpeg_drivers/components/factories/survey_factory.py

@@ -19,7 +19,7 @@
 if TYPE_CHECKING:
     from geoapps_utils.driver.params import BaseParams
 
-    from simpeg_drivers.params import BaseOptions
+    from simpeg_drivers.options import BaseOptions
 
 import numpy as np
 import simpeg.electromagnetics.time_domain as tdem

simpeg_drivers/components/locations.py

@@ -17,7 +17,7 @@
 if TYPE_CHECKING:
     from geoh5py.workspace import Workspace
 
-    from simpeg_drivers.params import BaseForwardOptions, BaseInversionOptions
+    from simpeg_drivers.options import BaseForwardOptions, BaseInversionOptions
 
 import numpy as np
 from geoh5py.objects import ObjectBase, Points

simpeg_drivers/components/meshes.py

@@ -24,7 +24,7 @@
 from octree_creation_app.utils import octree_2_treemesh, treemesh_2_octree
 from scipy.sparse import csr_matrix, identity
 
-from simpeg_drivers.params import BaseForwardOptions, BaseInversionOptions
+from simpeg_drivers.options import BaseForwardOptions, BaseInversionOptions
 from simpeg_drivers.utils.meshes import auto_mesh_parameters
 from simpeg_drivers.utils.utils import drape_2_tensor
 

simpeg_drivers/components/topography.py

@@ -19,7 +19,7 @@
     from geoh5py.workspace import Workspace
 
     from simpeg_drivers.components.meshes import InversionMesh
-    from simpeg_drivers.params import BaseOptions
+    from simpeg_drivers.options import BaseOptions
 
 import warnings
 

simpeg_drivers/components/windows.py

@@ -18,7 +18,7 @@
     from geoapps_utils.driver.params import BaseParams
     from geoh5py.workspace import Workspace
 
-    from simpeg_drivers.params import BaseForwardOptions, BaseInversionOptions
+    from simpeg_drivers.options import BaseForwardOptions, BaseInversionOptions
 
 import numpy as np
 from geoh5py.objects import Grid2D, PotentialElectrode

simpeg_drivers/depth_of_investigation/sensitivity_cutoff/driver.py

@@ -28,8 +28,8 @@
 from geoapps_utils.driver.driver import BaseDriver
 from geoh5py.data import FloatData
 
-from simpeg_drivers.depth_of_investigation.sensitivity_cutoff.params import (
-    SensitivityCutoffParams,
+from simpeg_drivers.depth_of_investigation.sensitivity_cutoff.options import (
+    SensitivityCutoffOptions,
 )
 
 
@@ -107,9 +107,9 @@ class SensitivityCutoffDriver(BaseDriver):
     below the provided cutoff percentage.
     """
 
-    _params_class = SensitivityCutoffParams
+    _params_class = SensitivityCutoffOptions
 
-    def __init__(self, params: SensitivityCutoffParams):
+    def __init__(self, params: SensitivityCutoffOptions):
         super().__init__(params)
 
     def run(self):

simpeg_drivers/depth_of_investigation/sensitivity_cutoff/params.py → simpeg_drivers/depth_of_investigation/sensitivity_cutoff/options.py

@@ -32,7 +32,7 @@
 from simpeg_drivers import assets_path
 
 
-class SensitivityCutoffParams(BaseData):
+class SensitivityCutoffOptions(BaseData):
     """
     Sensitivity cutoff parameters for depth of investigation studies.
 

simpeg_drivers/driver.py

@@ -59,11 +59,11 @@
     InversionWindow,
 )
 from simpeg_drivers.components.factories import DirectivesFactory, MisfitFactory
-from simpeg_drivers.params import (
+from simpeg_drivers.options import (
     BaseForwardOptions,
     BaseInversionOptions,
 )
-from simpeg_drivers.joint.params import BaseJointOptions
+from simpeg_drivers.joint.options import BaseJointOptions
 from simpeg_drivers.utils.utils import tile_locations
 from simpeg_drivers.utils.regularization import cell_neighbors, set_rotated_operators
 
@@ -72,7 +72,7 @@
 
 
 class InversionDriver(BaseDriver):
-    _params_class = BaseForwardOptions | BaseInversionOptions
+    _options_class = BaseForwardOptions | BaseInversionOptions
     _inversion_type: str | None = None
     _validations = None
 
@@ -582,7 +582,7 @@ def start(cls, filepath: str | Path, driver_class=None):
         )
 
         with ifile.data["geoh5"].open(mode="r+"):
-            params = driver_class._params_class.build(ifile)
+            params = driver_class._options_class.build(ifile)
             driver = driver_class(params)
 
         driver.run()

simpeg_drivers/electricals/__init__.py

@@ -15,7 +15,7 @@
     DC3DForwardOptions,
     DC3DInversionOptions,
 )
-from .induced_polarization.three_dimensions.params import (
+from .induced_polarization.three_dimensions.options import (
     IP3DForwardOptions,
     IP3DInversionOptions,
 )

simpeg_drivers/electricals/direct_current/pseudo_three_dimensions/driver.py

@@ -11,11 +11,11 @@
 
 from __future__ import annotations
 
-from simpeg_drivers.electricals.direct_current.pseudo_three_dimensions.params import (
+from simpeg_drivers.electricals.direct_current.pseudo_three_dimensions.options import (
     DCBatch2DForwardOptions,
     DCBatch2DInversionOptions,
 )
-from simpeg_drivers.electricals.direct_current.two_dimensions.params import (
+from simpeg_drivers.electricals.direct_current.two_dimensions.options import (
     DC2DForwardOptions,
     DC2DInversionOptions,
 )
@@ -25,14 +25,14 @@
 class DCBatch2DForwardDriver(BaseBatch2DDriver):
     """Direct Current batch 2D forward driver."""
 
-    _params_class = DCBatch2DForwardOptions
+    _options_class = DCBatch2DForwardOptions
     _params_2d_class = DC2DForwardOptions
     _validations = None
 
 
 class DCBatch2DInversionDriver(BaseBatch2DDriver):
     """Direct Current batch 2D inversion driver."""
 
-    _params_class = DCBatch2DInversionOptions
+    _options_class = DCBatch2DInversionOptions
     _params_2d_class = DC2DInversionOptions
     _validations = None

simpeg_drivers/electricals/direct_current/pseudo_three_dimensions/params.py → simpeg_drivers/electricals/direct_current/pseudo_three_dimensions/options.py

@@ -18,10 +18,10 @@
 from geoh5py.objects import Octree, PotentialElectrode
 
 from simpeg_drivers import assets_path
-from simpeg_drivers.electricals.params import (
+from simpeg_drivers.electricals.options import (
     FileControlOptions,
 )
-from simpeg_drivers.params import (
+from simpeg_drivers.options import (
     BaseForwardOptions,
     BaseInversionOptions,
     DrapeModelOptions,

simpeg_drivers/electricals/direct_current/three_dimensions/__init__.py

@@ -9,7 +9,7 @@
 # '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 
-from .params import DC3DForwardOptions, DC3DInversionOptions
+from .options import DC3DForwardOptions, DC3DInversionOptions
 
 # pylint: disable=unused-import
 # flake8: noqa

simpeg_drivers/electricals/direct_current/three_dimensions/driver.py

@@ -13,18 +13,18 @@
 
 from simpeg_drivers.driver import InversionDriver
 
-from .params import DC3DForwardOptions, DC3DInversionOptions
+from .options import DC3DForwardOptions, DC3DInversionOptions
 
 
 class DC3DForwardDriver(InversionDriver):
     """Direct Current 3D forward driver."""
 
-    _params_class = DC3DForwardOptions
+    _options_class = DC3DForwardOptions
     _validation = None
 
 
 class DC3DInversionDriver(InversionDriver):
     """Direct Current 3D inversion driver."""
 
-    _params_class = DC3DInversionOptions
+    _options_class = DC3DInversionOptions
     _validation = None

simpeg_drivers/electricals/direct_current/three_dimensions/params.py → simpeg_drivers/electricals/direct_current/three_dimensions/options.py

@@ -17,7 +17,7 @@
 from geoh5py.data import FloatData
 
 from simpeg_drivers import assets_path
-from simpeg_drivers.params import BaseForwardOptions, BaseInversionOptions
+from simpeg_drivers.options import BaseForwardOptions, BaseInversionOptions
 
 
 class DC3DForwardOptions(BaseForwardOptions):

simpeg_drivers/electricals/direct_current/two_dimensions/__init__.py

@@ -9,7 +9,7 @@
 # '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 
-from .params import DC2DForwardOptions, DC2DInversionOptions
+from .options import DC2DForwardOptions, DC2DInversionOptions
 
 
 __all__ = ["DC2DForwardOptions", "DC2DInversionOptions"]

simpeg_drivers/electricals/direct_current/two_dimensions/driver.py

@@ -13,18 +13,18 @@
 
 from simpeg_drivers.electricals.driver import Base2DDriver
 
-from .params import DC2DForwardOptions, DC2DInversionOptions
+from .options import DC2DForwardOptions, DC2DInversionOptions
 
 
 class DC2DForwardDriver(Base2DDriver):
     """Direct Current 2D forward driver."""
 
-    _params_class = DC2DForwardOptions
+    _options_class = DC2DForwardOptions
     _validations = None
 
 
 class DC2DInversionDriver(Base2DDriver):
     """Direct Current 2D inversion driver."""
 
-    _params_class = DC2DInversionOptions
+    _options_class = DC2DInversionOptions
     _validations = None

simpeg_drivers/electricals/direct_current/two_dimensions/params.py → simpeg_drivers/electricals/direct_current/two_dimensions/options.py

@@ -19,7 +19,7 @@
 from pydantic import BaseModel, ConfigDict, field_validator, model_validator
 
 from simpeg_drivers import assets_path
-from simpeg_drivers.params import (
+from simpeg_drivers.options import (
     BaseForwardOptions,
     BaseInversionOptions,
     DrapeModelOptions,

simpeg_drivers/electricals/driver.py

@@ -30,7 +30,7 @@
 from simpeg_drivers.components.windows import InversionWindow
 from simpeg_drivers.driver import InversionDriver
 from simpeg_drivers.line_sweep.driver import LineSweepDriver
-from simpeg_drivers.params import (
+from simpeg_drivers.options import (
     BaseForwardOptions,
     BaseInversionOptions,
     LineSelectionOptions,
@@ -80,7 +80,7 @@ def create_drape_mesh(self) -> DrapeModel:
 class BaseBatch2DDriver(LineSweepDriver):
     """Base class for batch 2D DC and IP forward and inversion drivers."""
 
-    _params_class: type[BaseForwardOptions | BaseInversionOptions]
+    _options_class: type[BaseForwardOptions | BaseInversionOptions]
     _params_2d_class: type[BaseForwardOptions | BaseInversionOptions]
     _validations = None
     _model_list: list[str] = []

simpeg_drivers/electricals/induced_polarization/pseudo_three_dimensions/driver.py

@@ -12,11 +12,11 @@
 from __future__ import annotations
 
 from simpeg_drivers.electricals.driver import BaseBatch2DDriver
-from simpeg_drivers.electricals.induced_polarization.pseudo_three_dimensions.params import (
+from simpeg_drivers.electricals.induced_polarization.pseudo_three_dimensions.options import (
     IPBatch2DForwardOptions,
     IPBatch2DInversionOptions,
 )
-from simpeg_drivers.electricals.induced_polarization.two_dimensions.params import (
+from simpeg_drivers.electricals.induced_polarization.two_dimensions.options import (
     IP2DForwardOptions,
     IP2DInversionOptions,
 )
@@ -25,7 +25,7 @@
 class IPBatch2DForwardDriver(BaseBatch2DDriver):
     """Induced Polarization batch 2D forward driver."""
 
-    _params_class = IPBatch2DForwardOptions
+    _options_class = IPBatch2DForwardOptions
     _params_2d_class = IP2DForwardOptions
     _validations = None
     _model_list = ["conductivity_model"]
@@ -34,7 +34,7 @@ class IPBatch2DForwardDriver(BaseBatch2DDriver):
 class IPBatch2DInversionDriver(BaseBatch2DDriver):
     """Induced Polarization batch 2D inversion driver."""
 
-    _params_class = IPBatch2DInversionOptions
+    _options_class = IPBatch2DInversionOptions
     _params_2d_class = IP2DInversionOptions
     _validations = None
     _model_list = ["conductivity_model"]

simpeg_drivers/electricals/induced_polarization/pseudo_three_dimensions/params.py → simpeg_drivers/electricals/induced_polarization/pseudo_three_dimensions/options.py

@@ -18,10 +18,10 @@
 from geoh5py.objects import Octree, PotentialElectrode
 
 from simpeg_drivers import assets_path
-from simpeg_drivers.electricals.params import (
+from simpeg_drivers.electricals.options import (
     FileControlOptions,
 )
-from simpeg_drivers.params import (
+from simpeg_drivers.options import (
     BaseForwardOptions,
     BaseInversionOptions,
     DrapeModelOptions,

simpeg_drivers/electricals/induced_polarization/three_dimensions/__init__.py

@@ -9,7 +9,7 @@
 # '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 
-from .params import (
+from .options import (
     IP3DForwardOptions,
     IP3DInversionOptions,
 )

simpeg_drivers/electricals/induced_polarization/three_dimensions/driver.py

@@ -13,7 +13,7 @@
 
 from simpeg_drivers.driver import InversionDriver
 
-from .params import (
+from .options import (
     IP3DForwardOptions,
     IP3DInversionOptions,
 )
@@ -22,12 +22,12 @@
 class IP3DForwardDriver(InversionDriver):
     """Induced Polarization 3D forward driver."""
 
-    _params_class = IP3DForwardOptions
+    _options_class = IP3DForwardOptions
     _validations = None
 
 
 class IP3DInversionDriver(InversionDriver):
     """Induced Polarization 3D inversion driver."""
 
-    _params_class = IP3DInversionOptions
+    _options_class = IP3DInversionOptions
     _validations = None