todo

Author: lachlangrose

LoopStructural/api/model.py

@@ -0,0 +1,6 @@
+def CreateModelWithSingleScalarField():
+    pass
+
+
+def AddFaultToModel():
+    pass

LoopStructural/interpolators/_geological_interpolator.py

@@ -141,7 +141,6 @@ def set_tangent_constraints(self, points: np.ndarray):
         self.up_to_date = False
 
     def set_interface_constraints(self, points: np.ndarray):
-
         self.data["interface"] = points
         self.up_to_date = False
 
@@ -209,6 +208,12 @@ def get_interface_constraints(self):
     def get_inequality_constraints(self):
         return self.data["inequality"]
 
+    def setup(self, **kwargs):
+        """
+        Runs all of the required setting up stuff
+        """
+        self._setup_interpolator(**kwargs)
+
     def setup_interpolator(self, **kwargs):
         """
         Runs all of the required setting up stuff

LoopStructural/modelling/core/geological_model.py

@@ -693,6 +693,7 @@ def set_stratigraphic_column(self, stratigraphic_column, cmap="tab20"):
 
         self.stratigraphic_column = stratigraphic_column
 
+    ## TODO CREATE SEPARATE API FOR THIS
     def get_interpolator(
         self,
         interpolatortype="FDI",
@@ -817,7 +818,6 @@ def get_interpolator(
             )
             return P2Interpolator(mesh)
         if interpolatortype == "FDI":
-
             # find the volume of one element
             if element_volume is None:
                 element_volume = box_vol / nelements
@@ -1648,7 +1648,6 @@ def create_and_add_fault(
             points=kwargs.get("points", False),
         )
         if "force_mesh_geometry" not in kwargs:
-
             fault_frame_builder.set_mesh_geometry(kwargs.get("fault_buffer", 0.2), 0)
         if "splay" in kwargs and "splayregion" in kwargs:
             fault_frame_builder.add_splay(kwargs["splay"], kwargs["splayregion"])
@@ -1669,6 +1668,7 @@ def create_and_add_fault(
 
         return fault
 
+    # TODO move rescale to bounding box/transformer
     def rescale(self, points: np.ndarray, inplace: bool = True) -> np.ndarray:
         """
         Convert from model scale to real world scale - in the future this
@@ -1691,6 +1691,7 @@ def rescale(self, points: np.ndarray, inplace: bool = True) -> np.ndarray:
         points += self.origin
         return points
 
+    # TODO move scale to bounding box/transformer
     def scale(self, points: np.ndarray, inplace: bool = True) -> np.ndarray:
         """Take points in UTM coordinates and reproject
         into scaled model space

docs/source/getting_started/todo.rst

@@ -0,0 +1,14 @@
+# Todo list for LoopStructural
+
+1. Create interpolation API 
+    - use scikit learn style
+    - allow interpolation to be used within scikit learn pipeline
+    - generic api for all interpolators
+    - 2D/3D
+
+2. Modelling API
+    - create api for using GeologicalModel class
+    - 
+
+
+3.