From df19b5859adb984950e4a19a907046ab72af4a74 Mon Sep 17 00:00:00 2001
From: Carlo Tibaldi <tlbl@dtu.dk>
Date: Mon, 7 Mar 2016 15:40:14 +0100
Subject: [PATCH] adding docs to calc_fatigue
---
wetb/prepost/windIO.py | 17 ++++++++++++++++-
1 file changed, 16 insertions(+), 1 deletion(-)
diff --git a/wetb/prepost/windIO.py b/wetb/prepost/windIO.py
index 11468c09..69fc6926 100755
--- a/wetb/prepost/windIO.py
+++ b/wetb/prepost/windIO.py
@@ -1013,7 +1013,22 @@ class LoadResults(object):
# TODO: general signal method, this is not HAWC2 specific, move out
def calc_fatigue(self, signal, no_bins=46, m=[3, 4, 6, 8, 10, 12], neq=1):
"""
- signal is 1D
+ Parameters
+ ----------
+
+ signal: 1D array
+ One dimentional array containing the signal.
+ no_bins: int
+ Number of bins for the binning of the amplitudes.
+ m: list
+ Values of the slope of the SN curve.
+ neq: int
+ Number of equivalent cycles
+
+ Returns
+ -------
+ eq: list
+ Damage equivalent loads for each m value.
"""
try:
--
GitLab