Skip to content

Commit 0a637dc

Browse files
committed
update docstrings
1 parent c2d0a93 commit 0a637dc

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

gstatsim.py

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -909,6 +909,9 @@ def skrige_sgs(prediction_grid, df, xx, yy, zz, num_points, vario, radius, seed=
909909
vtype is a string that can be either 'Exponential', 'Spherical', or 'Gaussian'
910910
radius : int, float
911911
search radius
912+
seed : None (default), integer or numpy.random._generator.Generator
913+
integer seed for random number generator or instance of it. Default is None in
914+
which case a random seed will be used
912915
quiet : bool
913916
If False, a progress bar will be printed to the console.
914917
Default is False
@@ -1002,6 +1005,9 @@ def okrige_sgs(prediction_grid, df, xx, yy, zz, num_points, vario, radius, seed=
10021005
vtype is a string that can be either 'Exponential', 'Spherical', or 'Gaussian'
10031006
radius : int, float
10041007
search radius
1008+
seed : None (default), integer or numpy.random._generator.Generator
1009+
integer seed for random number generator or instance of it. Default is None in
1010+
which case a random seed will be used
10051011
quiet : bool
10061012
If False, a progress bar will be printed to the console.
10071013
Default is False
@@ -1079,7 +1085,7 @@ def okrige_sgs(prediction_grid, df, xx, yy, zz, num_points, vario, radius, seed=
10791085
return sgs
10801086

10811087

1082-
def cluster_sgs(prediction_grid, df, xx, yy, zz, kk, num_points, df_gamma, radius, rng=None, quiet=False):
1088+
def cluster_sgs(prediction_grid, df, xx, yy, zz, kk, num_points, df_gamma, radius, seed=None, quiet=False):
10831089
"""
10841090
Sequential Gaussian simulation where variogram parameters are different for each k cluster. Uses simple kriging
10851091
@@ -1105,6 +1111,9 @@ def cluster_sgs(prediction_grid, df, xx, yy, zz, kk, num_points, df_gamma, radiu
11051111
vtype is a string that can be either 'Exponential', 'Spherical', or 'Gaussian'
11061112
radius : int, float
11071113
search radius
1114+
seed : None (default), integer or numpy.random._generator.Generator
1115+
integer seed for random number generator or instance of it. Default is None in
1116+
which case a random seed will be used
11081117
quiet : bool
11091118
If False, a progress bar will be printed to the console.
11101119
Default is False
@@ -1309,7 +1318,7 @@ def cokrige_mm1(prediction_grid, df1, xx1, yy1, zz1, df2, xx2, yy2, zz2, num_poi
13091318

13101319
return est_cokrige, var_cokrige
13111320

1312-
def cosim_mm1(prediction_grid, df1, xx1, yy1, zz1, df2, xx2, yy2, zz2, num_points, vario, radius, corrcoef, rng=None, quiet=False):
1321+
def cosim_mm1(prediction_grid, df1, xx1, yy1, zz1, df2, xx2, yy2, zz2, num_points, vario, radius, corrcoef, seed=None, quiet=False):
13131322
"""
13141323
Cosimulation under Markov model 1 assumptions
13151324
@@ -1343,6 +1352,9 @@ def cosim_mm1(prediction_grid, df1, xx1, yy1, zz1, df2, xx2, yy2, zz2, num_point
13431352
search radius
13441353
corrcoef : float
13451354
correlation coefficient between primary and secondary data
1355+
seed : None (default), integer or numpy.random._generator.Generator
1356+
integer seed for random number generator or instance of it. Default is None in
1357+
which case a random seed will be used
13461358
quiet : bool
13471359
If False, a progress bar will be printed to the console.
13481360
Default is False

0 commit comments

Comments
 (0)