Merge pull request #1026 from gempy-project/model_serialize

[ENH] Replace InterpolationOptions constructor with from_args method for serialization

Author: Leguark

docs/developers_notes/dev_log/2025_05.md

@@ -5,5 +5,25 @@
 
 # TODO: 
 -[ ] Saving and loading models 
+  - [ ] Make tests passing for InterpOptions serializable
+  - [ ] Try to make BaseModel dirctly to StructuralFrame
+  - [ ] Try to make Serializable directly to Grid
 -[ ] Better api for nugget effect optimization
 
+## Saving models
+- From gempy
+  - StructuralFrame
+  - OrientationsTable
+  - SurfacePointsTable
+- From Engine
+  - Input
+    - EngineGrid
+    - GeophysicsInput
+    - InterpolationOptions
+    - InputDataDescriptor
+    - InterpolatorInput
+  - Solutions (Not sure if I want to save them)
+      - RawArraysSolutions
+      - Solutions
+
+## What do I have in the engine server logic?

examples/examples/real/mik.py

@@ -312,7 +312,7 @@
         extent=[extent_from_data[0][0], extent_from_data[1][0], extent_from_data[0][1], extent_from_data[1][1], extent_from_data[0][2], extent_from_data[1][2]],
         resolution=(50, 50, 50)
     ),
-    interpolation_options=gp.data.InterpolationOptions(
+    interpolation_options=gp.data.InterpolationOptions.from_args(
         range=5,
         c_o=10,
         mesh_extraction=True,

gempy/modules/json_io/json_operations.py

@@ -155,7 +155,7 @@ def load_model_from_json(file_path: str):
         default_range = 1.7  # Match standard GemPy default
 
         # Create interpolation options with defaults if not provided
-        interpolation_options = InterpolationOptions(
+        interpolation_options = InterpolationOptions.from_args(
             range=data.get('interpolation_options', {}).get('kernel_options', {}).get('range', default_range),
             c_o=data.get('interpolation_options', {}).get('kernel_options', {}).get('c_o', 10),
             mesh_extraction=data.get('interpolation_options', {}).get('mesh_extraction', True),

requirements/requirements.txt

@@ -1,2 +1,2 @@
 # This install also numpy
-gempy_engine~=2025.1.1
+gempy_engine>=2025.2.0dev0,<2025.3.0

test/test_api/test_model_construction_granular.py

@@ -94,7 +94,7 @@ def test_create_structural_frame() -> StructuralFrame:
 
 def test_create_interpolation_options() -> InterpolationOptions:
     range_ = 1000.0
-    interpolation_options: InterpolationOptions = InterpolationOptions(
+    interpolation_options: InterpolationOptions = InterpolationOptions.from_args(
         range=range_,
         c_o=(range_ ** 2) / 14 / 3,
     )

test/test_modules/test_pile/test_stratigraphic_pile.py

@@ -129,7 +129,7 @@ def test_structural_elements_from_borehole_set(self, borehole_set: BoreholeSet):
                 extent=[extent_from_data[0][0], extent_from_data[1][0], extent_from_data[0][1], extent_from_data[1][1], extent_from_data[0][2], extent_from_data[1][2]],
                 resolution=(50, 50, 50)
             ),
-            interpolation_options=gp.data.InterpolationOptions(
+            interpolation_options=gp.data.InterpolationOptions.from_args(
                 range=5,
                 c_o=10,
                 mesh_extraction=True,

test/test_modules/test_serialize_model.py

@@ -0,0 +1,25 @@
+import pprint
+
+import gempy as gp
+from gempy.core.data.enumerators import ExampleModel
+from gempy_engine.core.data import InterpolationOptions
+
+
+def test_generate_horizontal_stratigraphic_model():
+    model: gp.data.GeoModel = gp.generate_example_model(ExampleModel.HORIZONTAL_STRAT, compute_model=False)
+    print(model.structural_frame)
+    options: InterpolationOptions = model.interpolation_options
+    pass
+
+def test_interpolation_options():
+    options = InterpolationOptions.from_args(
+        range=1.7,
+        c_o=10.
+    )
+    json = options.model_dump(mode="json")
+    # Pretty print json
+    pprint.pp(json)
+    
+    # Deserialize with pydantic
+    options2 = InterpolationOptions.model_validate(json)
+    assert options.__str__() == options2.__str__()