Skip to content

Commit 7d8b0b1

Browse files
Lachlan Groselachlangrose
authored andcommitted
fix: add parameter separator to clean up api
1 parent 1131735 commit 7d8b0b1

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

LoopStructural/modelling/core/geological_model.py

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -655,6 +655,7 @@ def set_stratigraphic_column(self, stratigraphic_column, cmap="tab20"):
655655
def create_and_add_foliation(
656656
self,
657657
series_surface_data: str,
658+
*,
658659
interpolatortype: str = "FDI",
659660
nelements: int = 1000,
660661
tol=None,
@@ -722,6 +723,7 @@ def create_and_add_foliation(
722723
def create_and_add_fold_frame(
723724
self,
724725
foldframe_data,
726+
*,
725727
interpolatortype="FDI",
726728
nelements=1000,
727729
tol=None,
@@ -776,6 +778,8 @@ def create_and_add_fold_frame(
776778
def create_and_add_folded_foliation(
777779
self,
778780
foliation_data,
781+
*,
782+
779783
interpolatortype="DFI",
780784
nelements=10000,
781785
buffer=0.1,
@@ -859,6 +863,7 @@ def create_and_add_folded_foliation(
859863
def create_and_add_folded_fold_frame(
860864
self,
861865
fold_frame_data,
866+
*,
862867
interpolatortype="FDI",
863868
nelements=10000,
864869
fold_frame=None,
@@ -947,6 +952,7 @@ def create_and_add_intrusion(
947952
self,
948953
intrusion_name,
949954
intrusion_frame_name,
955+
*,
950956
intrusion_frame_parameters={},
951957
intrusion_lateral_extent_model=None,
952958
intrusion_vertical_extent_model=None,
@@ -1224,7 +1230,7 @@ def add_onlap_unconformity(self, feature: GeologicalFeature, value: float) -> Ge
12241230
return uc_feature
12251231

12261232
def create_and_add_domain_fault(
1227-
self, fault_surface_data, nelements=10000, interpolatortype="FDI", **kwargs
1233+
self, fault_surface_data,*, nelements=10000, interpolatortype="FDI", **kwargs
12281234
):
12291235
"""
12301236
Parameters
@@ -1277,6 +1283,7 @@ def create_and_add_fault(
12771283
self,
12781284
fault_surface_data,
12791285
displacement,
1286+
*,
12801287
interpolatortype="FDI",
12811288
tol=None,
12821289
fault_slip_vector=None,
@@ -1418,7 +1425,7 @@ def create_and_add_fault(
14181425
return fault
14191426

14201427
# TODO move rescale to bounding box/transformer
1421-
def rescale(self, points: np.ndarray, inplace: bool = False) -> np.ndarray:
1428+
def rescale(self, points: np.ndarray, *, inplace: bool = False) -> np.ndarray:
14221429
"""
14231430
Convert from model scale to real world scale - in the future this
14241431
should also do transformations?
@@ -1441,7 +1448,7 @@ def rescale(self, points: np.ndarray, inplace: bool = False) -> np.ndarray:
14411448
return points
14421449

14431450
# TODO move scale to bounding box/transformer
1444-
def scale(self, points: np.ndarray, inplace: bool = False) -> np.ndarray:
1451+
def scale(self, points: np.ndarray, *, inplace: bool = False) -> np.ndarray:
14451452
"""Take points in UTM coordinates and reproject
14461453
into scaled model space
14471454
@@ -1467,7 +1474,7 @@ def scale(self, points: np.ndarray, inplace: bool = False) -> np.ndarray:
14671474
points /= self.scale_factor
14681475
return points
14691476

1470-
def regular_grid(self, nsteps=None, shuffle=True, rescale=False, order="C"):
1477+
def regular_grid(self, *, nsteps=None, shuffle=True, rescale=False, order="C"):
14711478
"""
14721479
Return a regular grid within the model bounding box
14731480
@@ -1483,7 +1490,7 @@ def regular_grid(self, nsteps=None, shuffle=True, rescale=False, order="C"):
14831490
"""
14841491
return self.bounding_box.regular_grid(nsteps=nsteps, shuffle=shuffle, order=order)
14851492

1486-
def evaluate_model(self, xyz: np.ndarray, scale: bool = True) -> np.ndarray:
1493+
def evaluate_model(self, xyz: np.ndarray, *, scale: bool = True) -> np.ndarray:
14871494
"""Evaluate the stratigraphic id at each location
14881495
14891496
Parameters
@@ -1559,7 +1566,7 @@ def evaluate_model(self, xyz: np.ndarray, scale: bool = True) -> np.ndarray:
15591566
logger.error(f"Model does not contain {group}")
15601567
return strat_id
15611568

1562-
def evaluate_model_gradient(self, points: np.ndarray, scale: bool = True) -> np.ndarray:
1569+
def evaluate_model_gradient(self, points: np.ndarray, *, scale: bool = True) -> np.ndarray:
15631570
"""Evaluate the gradient of the stratigraphic column at each location
15641571
15651572
Parameters

0 commit comments

Comments
 (0)