hydrotoolbox 2.1.0__tar.gz → 2.3.0__tar.gz

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/.github/workflows/clean-workflow-runs.yml

@@ -16,10 +16,6 @@ jobs:
             - name: Delete workflow runs
               uses: dmvict/clean-workflow-runs@v1.2.2
 
-        with:
-
-            run_conclusions: |
-                failure
-                timed_out
-            save_period: 5
-            save_min_runs_number: 1
+              with:
+                  save_period: 5
+                  save_min_runs_number: 1

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/.pre-commit-config.yaml

@@ -29,7 +29,7 @@ repos:
 
     - repo: https://github.com/astral-sh/ruff-pre-commit
       # Ruff version.
-      rev: v0.15.6
+      rev: v0.15.16
       hooks:
           # Run the linter.
           - id: ruff
@@ -40,7 +40,7 @@ repos:
             types_or: [python, pyi, jupyter]
 
     - repo: https://github.com/pycqa/isort
-      rev: 8.0.1
+      rev: 9.0.0a3
       hooks:
           - id: isort
             name: isort (python)
@@ -52,7 +52,7 @@ repos:
             types: [pyi]
 
     - repo: https://github.com/pappasam/toml-sort
-      rev: v0.24.3
+      rev: v0.24.4
       hooks:
           - id: toml-sort-fix
             args: [--in-place, --spaces-indent-inline-array, '4']
@@ -91,7 +91,7 @@ repos:
           - id: pyupgrade
 
     - repo: https://github.com/commitizen-tools/commitizen
-      rev: v4.13.9
+      rev: v4.16.3
       hooks:
           - id: commitizen
             stages: [commit-msg]

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/CHANGELOG.md

@@ -1,3 +1,15 @@
+## v2.3.0 (2026-06-09)
+
+### Feat
+
+- add "passes" to Lynne Hollick function
+
+## v2.2.0 (2026-03-29)
+
+### Feat
+
+- moved to using scipy lfilter for most baseflow_sep filters, better separation between API and CLI
+
 ## v2.1.0 (2026-03-19)
 
 ### Feat

{hydrotoolbox-2.1.0/src/hydrotoolbox.egg-info → hydrotoolbox-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hydrotoolbox
-Version: 2.1.0
+Version: 2.3.0
 Summary: Command line script and Python library for analysis of flow time-series.
 Author-email: Tim Cera <tim@cerazone.net>
 License: BSD-3-Clause
@@ -72,7 +72,7 @@ or numpy (http://numpy.scipy.org) for any heavy lifting.
 
 Requirements
 ------------
-* python 3.7 or higher
+* python 3.10 or higher
 
 Installation
 ------------

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/README.rst

@@ -31,7 +31,7 @@ or numpy (http://numpy.scipy.org) for any heavy lifting.
 
 Requirements
 ------------
-* python 3.7 or higher
+* python 3.10 or higher
 
 Installation
 ------------

hydrotoolbox-2.3.0/VERSION

@@ -0,0 +1 @@
+2.3.0

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/docs/command_line.rst

@@ -28,7 +28,7 @@ baseflow_sep chapman
    :prompt:
 
 baseflow_sep chapman_maxwell
----------------
+----------------------------
 .. program-output:: hydrotoolbox baseflow_sep chapman_maxwell --help
    :prompt:
 
@@ -58,7 +58,7 @@ baseflow_sep ihacres
    :prompt:
 
 baseflow_sep lyne_hollick
----------------
+-------------------------
 .. program-output:: hydrotoolbox baseflow_sep lyne_hollick --help
    :prompt:
 

hydrotoolbox-2.3.0/docs/function_summary.rst

@@ -0,0 +1,28 @@
+.. include:: ../BADGES.rst
+
+Python API Function Summary
+===========================
+
+.. autosummary::
+    :toctree: _function_autosummary
+
+    hydrotoolbox.about
+    hydrotoolbox.baseflow_sep.boughton
+    hydrotoolbox.baseflow_sep.chapman
+    hydrotoolbox.baseflow_sep.chapman_maxwell
+    hydrotoolbox.baseflow_sep.eckhardt
+    hydrotoolbox.baseflow_sep.ewma
+    hydrotoolbox.baseflow_sep.five_day
+    hydrotoolbox.baseflow_sep.furey
+    hydrotoolbox.baseflow_sep.ihacres
+    hydrotoolbox.baseflow_sep.lyne_hollick
+    hydrotoolbox.baseflow_sep.ukih
+    hydrotoolbox.baseflow_sep.usgs_hysep_fixed
+    hydrotoolbox.baseflow_sep.usgs_hysep_local
+    hydrotoolbox.baseflow_sep.usgs_hysep_slide
+    hydrotoolbox.baseflow_sep.willems
+    hydrotoolbox.exceedance_time
+    hydrotoolbox.flow_duration
+    hydrotoolbox.indices
+    hydrotoolbox.recession
+    hydrotoolbox.storm_events

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/docs/index.rst

@@ -5,10 +5,10 @@
 hydrotoolbox
 ============
 
-This is the home page for hydrotoolbox.  hydrotoolbox is a command line program and
-Python library for hydrologic analysis.
+This is the home page for hydrotoolbox.  hydrotoolbox is a command line program
+and Python library for hydrologic analysis.
 
-hydrotoolbox should work with Python 3.6+.
+hydrotoolbox should work with Python 3.10+.
 
 Table of Contents
 -----------------

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/pyproject.toml

@@ -65,7 +65,7 @@ github = "https://github.com/timcera/hydrotoolbox"
 name = "cz_conventional_commits"
 tag_format = "v$version"
 update_changelog_on_bump = true
-version = "2.1.0"
+version = "2.3.0"
 version_files = ["VERSION"]
 
 [tool.isort]

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/__init__.py

@@ -1,21 +1,22 @@
 """Define hydrotoolbox package."""
 
+# Import main functions from hydrotoolbox module
+from hydrotoolbox.hydrotoolbox import (
+    about,
+    exceedance_time,
+    flow_duration,
+    indices,
+    recession,
+    storm_events,
+)
+
+# Define __all__ list
 __all__ = [
+    # Main functions
     "about",
-    "baseflow_sep",
     "exceedance_time",
     "flow_duration",
     "indices",
     "recession",
     "storm_events",
 ]
-
-from .hydrotoolbox import (
-    about,
-    baseflow_sep,
-    exceedance_time,
-    flow_duration,
-    indices,
-    recession,
-    storm_events,
-)

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/comparison.py

@@ -1,3 +1,8 @@
+__all__ = [
+    "KGE",
+    "strict_baseflow",
+]
+
 import numpy as np
 
 

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/methods/boughton.py

@@ -1,3 +1,7 @@
+__all__ = [
+    "boughton",
+]
+
 from hydrotoolbox.baseflow.methods.general_form import general_form_digital_filter
 
 

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/methods/chapman.py

@@ -1,3 +1,7 @@
+__all__ = [
+    "chapman",
+]
+
 from hydrotoolbox.baseflow.methods.general_form import general_form_digital_filter
 
 

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/methods/chapman_maxwell.py

@@ -1,3 +1,7 @@
+__all__ = [
+    "chapman_maxwell",
+]
+
 from hydrotoolbox.baseflow.methods.general_form import general_form_digital_filter
 
 

hydrotoolbox-2.3.0/src/hydrotoolbox/baseflow/methods/eckhardt.py

@@ -0,0 +1,22 @@
+__all__ = [
+    "eckhardt",
+]
+
+from hydrotoolbox.baseflow.methods.general_form import general_form_digital_filter
+
+
+def eckhardt(flow, k, BFImax):
+    """Eckhardt filter (Eckhardt, 2005)"""
+    denom = 1 - k * BFImax
+    alpha = ((1 - BFImax) * k) / denom
+    beta = ((1 - k) * BFImax) / denom
+    gamma = 0
+
+    return general_form_digital_filter(flow, alpha, beta, gamma)
+
+
+def f_Eckhardt(a):
+    def _Eckhardt(Q, b_LH, BFImax):
+        return eckhardt(Q, b_LH, a, BFImax)
+
+    return _Eckhardt

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/methods/ewma.py

@@ -1,3 +1,7 @@
+__all__ = [
+    "ewma",
+]
+
 import numpy as np
 
 

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/methods/five_day.py

@@ -7,6 +7,10 @@ hydrotoolbox baseflow_sep eckhardt,sliding < daily.csv
 
 hydrotoolbox recession"""
 
+__all__ = [
+    "five_day",
+]
+
 import pandas as pd
 
 

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/methods/fixed.py

@@ -1,6 +1,10 @@
+__all__ = [
+    "fixed",
+]
+
 import numpy as np
 
-from .local import hysep_interval
+from hydrotoolbox.baseflow.methods.local import hysep_interval
 
 
 def fixed(Q, area=None, num_days=None):

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/methods/furey.py

@@ -1,3 +1,7 @@
+__all__ = [
+    "furey",
+]
+
 import numpy as np
 
 

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/methods/ihacres.py

@@ -7,9 +7,15 @@ hydrotoolbox baseflow_sep eckhardt,sliding < daily.csv
 
 hydrotoolbox recession"""
 
+__all__ = [
+    "ihacres",
+]
+
+from hydrotoolbox.baseflow.methods.general_form import general_form_digital_filter
+
 
 def ihacres(
-    Q,
+    flow,
     k: float,
     C: float,
     a: float,
@@ -18,13 +24,8 @@ def ihacres(
 
     Jakeman-Hornberger digital filter (Jakeman and Hornberger, 1993)
     """
-    Qb = Q.copy()
-
     alpha = k / (1 + C)
     beta = C / (1 + C)
+    gamma = a
 
-    for row in range(1, len(Q)):
-        Qb[row] = alpha * Qb[row - 1] + beta * (Q[row] + a * Q[row - 1])
-    mask = Qb > Q
-    Qb[mask] = Q[mask]
-    return Qb
+    return general_form_digital_filter(flow, alpha, beta, gamma)

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/methods/local.py

@@ -1,5 +1,9 @@
 from typing import Optional
 
+__all__ = [
+    "local",
+]
+
 import numpy as np
 
 try:
@@ -7,7 +11,7 @@ try:
 except ImportError:
     from pydantic import validate_arguments as validate_call
 
-from .ukih import linear_interpolation
+from hydrotoolbox.baseflow.methods.ukih import linear_interpolation
 
 
 def local(Q, b_LH, area=None, num_days=None):

hydrotoolbox-2.3.0/src/hydrotoolbox/baseflow/methods/lyne_hollick.py

@@ -0,0 +1,19 @@
+__all__ = [
+    "lyne_hollick",
+]
+
+from hydrotoolbox.baseflow.methods.general_form import general_form_digital_filter
+
+
+def lyne_hollick(flow, k, passes=1):
+    """LH digital filter (Lyne & Hollick, 1979)"""
+    alpha = k
+    beta = (1 - k) / 2
+    gamma = 1.0
+
+    for pss in range(passes):
+        if pss > 0:
+            flow = flow[::-1]
+        flow, count = general_form_digital_filter(flow, alpha, beta, gamma)
+
+    return flow, count

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/methods/slide.py

@@ -1,6 +1,10 @@
+__all__ = [
+    "slide",
+]
+
 import numpy as np
 
-from .local import hysep_interval
+from hydrotoolbox.baseflow.methods.local import hysep_interval
 
 
 def slide(Q, area=None, num_days=None):

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/methods/strict.py

@@ -7,7 +7,11 @@ hydrotoolbox baseflow_sep eckhardt,sliding < daily.csv
 
 hydrotoolbox recession"""
 
-from ..comparison import strict_baseflow
+__all__ = [
+    "strict",
+]
+
+from hydrotoolbox.baseflow.comparison import strict_baseflow
 
 
 def strict(Q):

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/methods/ukih.py

@@ -1,3 +1,7 @@
+__all__ = [
+    "ukih",
+]
+
 import numpy as np
 
 

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/methods/willems.py

@@ -1,3 +1,7 @@
+__all__ = [
+    "willems",
+]
+
 from hydrotoolbox.baseflow.methods.general_form import general_form_digital_filter
 
 

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/param_estimate.py

@@ -1,6 +1,11 @@
+__all__ = [
+    "recession_coefficient",
+    "recession_period",
+]
+
 import numpy as np
 
-from .utils import NSE, moving_average, multi_arange
+from hydrotoolbox.baseflow.utils import NSE, moving_average, multi_arange
 
 
 def recession_coefficient(Q, strict, date=None, ice_period=None):
@@ -31,7 +36,7 @@ def recession_coefficient(Q, strict, date=None, ice_period=None):
     return np.exp(-1 / K)
 
 
-def param_calibrate(param_range, method, Q, b_LH):
+def param_calibrate(param_range, method, Q, b_LH=0):
     idx_rec = recession_period(Q)
     idx_oth = np.full(Q.shape[0], True)
     idx_oth[idx_rec] = False

{hydrotoolbox-2.1.0 → hydrotoolbox-2.3.0}/src/hydrotoolbox/baseflow/separation.py

@@ -37,6 +37,7 @@ def separation(
     C=None,
     a=None,
     bfi_max=None,
+    passes=1,
 ):
     if method == "all":
         method = [
@@ -72,12 +73,11 @@ def separation(
             "ukih",
             "local",
             "chapman_maxwell",
-            "furey",
-            "eckhardt",
             "ewma",
+            "furey",
             "willems",
         ]:
-            b_lh = lyne_hollick(Q, k=k)[0]
+            b_lh = lyne_hollick(Q, k=k, passes=passes)[0]
 
         if m == "ukih":
             b[m] = ukih(Q, b_lh)
@@ -92,7 +92,7 @@ def separation(
             b[m] = slide(Q, area=area, num_days=num_days)
 
         if m == "lyne_hollick":
-            b[m] = lyne_hollick(Q, k=k)[0]
+            b[m] = lyne_hollick(Q, k=k, passes=passes)[0]
 
         if m == "chapman":
             b[m] = chapman(Q, k)[0]
@@ -120,7 +120,7 @@ def separation(
                     np.arange(0.0001, 1, 0.0001), f_Eckhardt(k), Q, b_lh
                 )
             bfi_max = float(bfi_max)
-            b[m] = eckhardt(Q, b_lh, k, bfi_max)[0]
+            b[m] = eckhardt(Q, k, bfi_max)[0]
 
         if m == "ewma":
             e = param_calibrate(np.arange(0.0001, 0.5, 0.0001), ewma, Q, b_lh)
@@ -131,7 +131,7 @@ def separation(
             b[m] = willems(Q, b_lh, k, w)[0]
 
         if m == "ihacres":
-            b[m] = ihacres(Q, k=k, C=C, a=a)
+            b[m] = ihacres(Q, k=k, C=C, a=a)[0]
 
         if m == "strict":
             b[m] = strict(Q)