final typo fix

MHKiT-Software · Oct 30, 2023 · 8a17fc5 · 8a17fc5
1 parent 5574910
commit 8a17fc5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/mhkit/loads/extreme.py b/mhkit/loads/extreme.py
@@ -3,7 +3,7 @@
 from scipy import stats
 from scipy import optimize
 from mhkit.wave.resource import frequency_moment
-import mhkit.utils.upcrossing  as upcrossing
+from mhkit.utils import upcrossing, custom
 
 
 def global_peaks(t, data):
@@ -31,7 +31,7 @@ def global_peaks(t, data):
     assert isinstance(data, np.ndarray), 'data must be of type np.ndarray'
 
     # Find zero up-crossings
-    inds = upcrossing.upcrossing(t, data)
+    inds = upcrossing(t, data)
 
     # We also include the final point in the dataset
     inds = np.append(inds, len(data)-1)
@@ -44,7 +44,7 @@ def global_peaks(t, data):
     # starts the zero crossing period, ind1.
     func = lambda ind1, ind2: np.argmax(data[ind1:ind2]) + ind1
 
-    peak_inds = np.array(upcrossing.custom(t, data, func, inds), dtype=int)
+    peak_inds = np.array(custom(t, data, func, inds), dtype=int)
 
     return t[peak_inds], data[peak_inds]
 

diff --git a/mhkit/utils/upcrossing.py b/mhkit/utils/upcrossing.py
@@ -63,7 +63,7 @@ def upcrossing(t, data):
     Returns
     -------
     inds: np.array
-        Zero crossing indicies
+        Zero crossing indices
     """
     if not isinstance(t, np.ndarray):
         raise TypeError('t must be of type np.ndarray')
@@ -97,7 +97,7 @@ def peaks(t, data, inds=None):
     data: np.array
         Signal time-series.
     inds: np.array
-        Optional indicies for the upcrossing. Useful
+        Optional indices for the upcrossing. Useful
         when using several of the upcrossing methods
         to avoid repeating the upcrossing analysis 
         each time.
@@ -128,7 +128,7 @@ def troughs(t, data, inds=None):
     data: np.array
         Signal time-series.
     inds: np.array
-        Optional indicies for the upcrossing. Useful
+        Optional indices for the upcrossing. Useful
         when using several of the upcrossing methods
         to avoid repeating the upcrossing analysis 
         each time.
@@ -159,7 +159,7 @@ def heights(t, data, inds=None):
     data: np.array
         Signal time-series.
     inds: np.array
-        Optional indicies for the upcrossing. Useful
+        Optional indices for the upcrossing. Useful
         when using several of the upcrossing methods
         to avoid repeating the upcrossing analysis 
         each time.
@@ -189,7 +189,7 @@ def periods(t, data, inds=None):
     data: np.array
         Signal time-series.
     inds: np.array
-        Optional indicies for the upcrossing. Useful
+        Optional indices for the upcrossing. Useful
         when using several of the upcrossing methods
         to avoid repeating the upcrossing analysis 
         each time.
@@ -220,7 +220,7 @@ def custom(t, data, func, inds=None):
         given t[ind1], t[ind2], where ind1 < ind2, correspond
         to the start and end of an upcrossing section.
     inds: np.array
-        Optional indicies for the upcrossing. Useful
+        Optional indices for the upcrossing. Useful
         when using several of the upcrossing methods
         to avoid repeating the upcrossing analysis 
         each time.