Add warning on setting lower_bound for mvi

Author: domfournier

simpeg_drivers/potential_fields/magnetic_vector/params.py

@@ -13,8 +13,10 @@
 
 from pathlib import Path
 from typing import ClassVar
+from warnings import warn
 
 from geoh5py.data import FloatData
+from pydantic import model_validator
 
 from simpeg_drivers import assets_path
 from simpeg_drivers.params import BaseForwardOptions, BaseInversionOptions
@@ -131,3 +133,14 @@ class MVIInversionOptions(BaseInversionOptions):
     starting_declination: float | FloatData | None = None
     reference_inclination: float | FloatData | None = None
     reference_declination: float | FloatData | None = None
+
+    @model_validator(mode="after")
+    def validate_lower_bound(self):
+        if self.lower_bound is not None:
+            warn(
+                "Parameter 'lower_bound' for Magnetic Vector Inversion has been deprecated. "
+                "Defaulting to the negative value of 'upper_bound'.",
+                stacklevel=1,
+            )
+            self.lower_bound = None
+        return self

tests/run_tests/driver_mvi_test.py

@@ -16,6 +16,7 @@
 from geoh5py.groups.property_group import GroupTypeEnum
 from geoh5py.objects import Curve
 from geoh5py.workspace import Workspace
+from pytest import warns
 
 from simpeg_drivers.params import ActiveCellsOptions
 from simpeg_drivers.potential_fields import (
@@ -166,30 +167,34 @@ def test_magnetic_vector_bounds_run(
 
         # Run the inverse
         active_cells = ActiveCellsOptions(topography_object=topography)
-        params = MVIInversionOptions(
-            geoh5=geoh5,
-            mesh=mesh,
-            active_cells=active_cells,
-            inducing_field_strength=inducing_field[0],
-            inducing_field_inclination=inducing_field[1],
-            inducing_field_declination=inducing_field[2],
-            data_object=tmi.parent,
-            starting_model=1e-4,
-            reference_model=0.0,
-            s_norm=0.0,
-            x_norm=1.0,
-            y_norm=1.0,
-            z_norm=1.0,
-            gradient_type="components",
-            tmi_channel=tmi,
-            tmi_uncertainty=4.0,
-            upper_bound=upper_bound,
-            max_global_iterations=max_iterations,
-            initial_beta_ratio=1e1,
-            store_sensitivities="ram",
-            save_sensitivities=True,
-            percentile=100,
-        )
+        with warns(
+            UserWarning, match="Parameter 'lower_bound' for Magnetic Vector Inversion"
+        ):
+            params = MVIInversionOptions(
+                geoh5=geoh5,
+                mesh=mesh,
+                active_cells=active_cells,
+                inducing_field_strength=inducing_field[0],
+                inducing_field_inclination=inducing_field[1],
+                inducing_field_declination=inducing_field[2],
+                data_object=tmi.parent,
+                starting_model=1e-4,
+                reference_model=0.0,
+                s_norm=0.0,
+                x_norm=1.0,
+                y_norm=1.0,
+                z_norm=1.0,
+                gradient_type="components",
+                tmi_channel=tmi,
+                tmi_uncertainty=4.0,
+                lower_bound=1e-6,
+                upper_bound=upper_bound,
+                max_global_iterations=max_iterations,
+                initial_beta_ratio=1e1,
+                store_sensitivities="ram",
+                save_sensitivities=True,
+                percentile=100,
+            )
         params.write_ui_json(path=tmp_path / "Inv_run.ui.json")
 
     driver = MVIInversionDriver(params)