updated docs

Deltares-research · Oct 15, 2024 · eaf15f2 · eaf15f2
1 parent 1679e43
commit eaf15f2
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/docs/whats-new.md b/docs/whats-new.md
@@ -4,6 +4,7 @@
 
 ### Feat
 - expanded physical_break_dict in [#151](https://github.com/Deltares-research/kenmerkendewaarden/pull/151)
+- linear fit for slotgemiddelden (no nodal) in [#157](https://github.com/Deltares-research/kenmerkendewaarden/pull/157)
 
 
 ## 0.3.0 (2024-10-01)

diff --git a/kenmerkendewaarden/slotgemiddelden.py b/kenmerkendewaarden/slotgemiddelden.py
@@ -30,6 +30,10 @@ def calc_slotgemiddelden(
 ):
     """
     Compute slotgemiddelden from measurement timeseries and optionally also from extremes timeseries.
+    A simple linear trend is used to avoid all pretend-accuracy. However, when fitting a
+    linear trend on a limited amount of data, the nodal cycle and wind effects will cause
+    the model fit to be inaccurate. It is wise to use at least 30 years of data for 
+    a valid fit, this is >1.5 times the nodal cycle.
 
     Parameters
     ----------