Improve time series settings documentation (#639)

pastas · Sep 18, 2023 · f52d5f8 · f52d5f8
2 parents c8e9b6f + 4cdd191
commit f52d5f8
Show file tree

Hide file tree

Showing 10 changed files with 392 additions and 102 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -119,6 +119,8 @@
     "ml": "pastas.model.Model",
     "TimestampType": "pandas.Timestamp",
 }
+# add custom section to docstrings in Parameters style
+napoleon_custom_sections = [("Time series settings", "params_style")]
 
 # -- Autodoc, autosummary, and autosectionlabel settings ------------------------------
 

diff --git a/pastas/__init__.py b/pastas/__init__.py
@@ -3,10 +3,12 @@
 
 from pandas.plotting import register_matplotlib_converters
 
+import pastas.objective_functions as objfunc
 import pastas.plots as plots
 import pastas.recharge as rch
 import pastas.stats as stats
 import pastas.timeseries_utils as ts
+
 from .decorators import set_use_numba
 from .model import Model
 from .modelcompare import CompareModels
@@ -25,8 +27,7 @@
     Polder,
     Spline,
 )
-from .solver import LeastSquares, LmfitSolve, EmceeSolve
-import pastas.objective_functions as objfunc
+from .solver import EmceeSolve, LeastSquares, LmfitSolve
 from .stressmodels import (
     ChangeModel,
     Constant,

diff --git a/pastas/objective_functions.py b/pastas/objective_functions.py
@@ -2,7 +2,7 @@
 `EmceeSolve` solver.   
 
 """
-from numpy import pi, log
+from numpy import log, pi
 from pandas import DataFrame
 
 

diff --git a/pastas/rcparams.py b/pastas/rcparams.py
@@ -1,54 +1,59 @@
+from .typing import OseriesSettingsDict, StressSettingsDict
+
 rcParams = {
     "timeseries": {
-        "oseries": {"fill_nan": "drop", "sample_down": "drop"},
-        "prec": {
-            "sample_up": "bfill",
-            "sample_down": "mean",
-            "fill_nan": 0.0,
-            "fill_before": "mean",
-            "fill_after": "mean",
-        },
-        "evap": {
-            "sample_up": "bfill",
-            "sample_down": "mean",
-            "fill_before": "mean",
-            "fill_after": "mean",
-            "fill_nan": "interpolate",
-        },
-        "well": {
-            "sample_up": "bfill",
-            "sample_down": "mean",
-            "fill_nan": 0.0,
-            "fill_before": 0.0,
-            "fill_after": 0.0,
-        },
-        "waterlevel": {
-            "sample_up": "interpolate",
-            "sample_down": "mean",
-            "fill_before": "mean",
-            "fill_after": "mean",
-            "fill_nan": "interpolate",
-        },
-        "level": {
-            "sample_up": "interpolate",
-            "sample_down": "mean",
-            "fill_before": "mean",
-            "fill_after": "mean",
-            "fill_nan": "interpolate",
-        },
-        "flux": {
-            "sample_up": "bfill",
-            "sample_down": "mean",
-            "fill_before": "mean",
-            "fill_after": "mean",
-            "fill_nan": 0.0,
-        },
-        "quantity": {
-            "sample_up": "divide",
-            "sample_down": "sum",
-            "fill_before": "mean",
-            "fill_after": "mean",
-            "fill_nan": 0.0,
-        },
+        "oseries": OseriesSettingsDict(
+            fill_nan="drop",
+            sample_down="drop",
+        ),
+        "prec": StressSettingsDict(
+            sample_up="bfill",
+            sample_down="mean",
+            fill_nan=0.0,
+            fill_before="mean",
+            fill_after="mean",
+        ),
+        "evap": StressSettingsDict(
+            sample_up="bfill",
+            sample_down="mean",
+            fill_before="mean",
+            fill_after="mean",
+            fill_nan="interpolate",
+        ),
+        "well": StressSettingsDict(
+            sample_up="bfill",
+            sample_down="mean",
+            fill_nan=0.0,
+            fill_before=0.0,
+            fill_after=0.0,
+        ),
+        "waterlevel": StressSettingsDict(
+            sample_up="interpolate",
+            sample_down="mean",
+            fill_before="mean",
+            fill_after="mean",
+            fill_nan="interpolate",
+        ),
+        "level": StressSettingsDict(
+            sample_up="interpolate",
+            sample_down="mean",
+            fill_before="mean",
+            fill_after="mean",
+            fill_nan="interpolate",
+        ),
+        "flux": StressSettingsDict(
+            sample_up="bfill",
+            sample_down="mean",
+            fill_before="mean",
+            fill_after="mean",
+            fill_nan=0.0,
+        ),
+        "quantity": StressSettingsDict(
+            sample_up="divide",
+            sample_down="sum",
+            fill_before="mean",
+            fill_after="mean",
+            fill_nan=0.0,
+        ),
     }
 }
diff --git a/pastas/solver.py b/pastas/solver.py
@@ -20,7 +20,6 @@
 from scipy.linalg import svd
 from scipy.optimize import least_squares
 
-
 from pastas.objective_functions import GaussianLikelihood
 from pastas.typing import ArrayLike, CallBack, Function, Model