hydrotoolbox 2.0.14__tar.gz → 2.2.0__tar.gz

{hydrotoolbox-2.0.14 → hydrotoolbox-2.2.0}/.github/workflows/pypi-package.yml

@@ -28,7 +28,7 @@ jobs:
 
         steps:
             - name: Checkout source
-              uses: actions/checkout@v4
+              uses: actions/checkout@v6
               with:
                   submodules: recursive
 
@@ -38,7 +38,7 @@ jobs:
                   python -m build
 
             - name: Download artifact
-              uses: actions/download-artifact@v4
+              uses: actions/download-artifact@v8
               with:
                   path: dist
                   merge-multiple: true

{hydrotoolbox-2.0.14 → hydrotoolbox-2.2.0}/.github/workflows/tests.yml

@@ -21,46 +21,34 @@ jobs:
             fail-fast: false
             matrix:
                 os: [ubuntu-latest, macos-latest, windows-latest]
-                python-versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
-                pandas-versions: [1.5.3, 2.0.0, 2.2.0, 2.2.3]
-                toolchain:
-                    - {compiler: gcc, version: 13}
+                python-versions: ['3.10', '3.11', '3.12', '3.13', '3.14']
+                pandas-versions: [pandas<2.0.0, pandas>=2.0.0]
+                numpy-versions: [numpy<2.0.0, numpy>=2.0.0]
+
                 exclude:
+                    - python-versions: '3.12'
+                      pandas-versions: pandas<2.0.0
                     - python-versions: '3.13'
-                      pandas-versions: 1.5.3
-                    - python-versions: '3.13'
-                      pandas-versions: 2.0.0
+                      pandas-versions: pandas<2.0.0
+                    - python-versions: '3.14'
+                      pandas-versions: pandas<2.0.0
+                    - python-versions: '3.12'
+                      numpy-versions: numpy<2.0.0
                     - python-versions: '3.13'
-                      pandas-versions: 2.2.0
-                    - python-versions: '3.8'
-                      pandas-versions: 2.2.0
-                    - python-versions: '3.8'
-                      pandas-versions: 2.2.3
-                    - os: windows-latest
-                      python-versions: '3.8'
-                    - os: windows-latest
-                      python-versions: '3.9'
-                      pandas-versions: 2.2.0
-                    - os: windows-latest
-                      python-versions: '3.10'
-                      pandas-versions: 2.2.0
-                    - os: windows-latest
-                      python-versions: '3.11'
-                      pandas-versions: 2.2.0
-                    - os: windows-latest
-                      python-versions: '3.12'
-                      pandas-versions: 2.2.0
-                    - os: windows-latest
-                      python-versions: '3.13'
+                      numpy-versions: numpy<2.0.0
+                    - python-versions: '3.14'
+                      numpy-versions: numpy<2.0.0
+                    - pandas-versions: pandas<2.0.0
+                      numpy-versions: numpy>=2.0.0
 
         steps:
             - name: Checkout repository
-              uses: actions/checkout@v4
+              uses: actions/checkout@v6
               with:
                   submodules: recursive
 
             - name: Set up Python ${{ matrix.python-versions }}
-              uses: actions/setup-python@v5
+              uses: actions/setup-python@v6
               with:
                   python-version: ${{ matrix.python-versions }}
 
@@ -74,10 +62,12 @@ jobs:
                   version ${{ matrix.pandas-versions }}
               run: >
                   python -m pip install
-                  pandas==${{ matrix.pandas-versions }} 'numpy<2' .
+                  '${{ matrix.pandas-versions }}'
+                  '${{ matrix.numpy-versions }}' .
 
             - name: Test with pytest
-              run: python -m pytest --cov
+              run: |
+                  python -m pytest --cov
 
             - name: Upload coverage data to coveralls.io
               uses: coverallsapp/github-action@v2

{hydrotoolbox-2.0.14 → hydrotoolbox-2.2.0}/.pre-commit-config.yaml

@@ -11,7 +11,7 @@ exclude: |
 
 repos:
     - repo: https://github.com/pre-commit/pre-commit-hooks
-      rev: v5.0.0
+      rev: v6.0.0
       hooks:
           - id: check-case-conflict
           - id: check-docstring-first
@@ -23,15 +23,13 @@ repos:
           - id: check-xml
           - id: end-of-file-fixer
             exclude: notebooks/tstoolbox_plot_bash.sh
-          - id: fix-encoding-pragma
-            args: [--remove]
           - id: mixed-line-ending
           - id: trailing-whitespace
             exclude: notebooks/tstoolbox_plot_bash.sh
 
     - repo: https://github.com/astral-sh/ruff-pre-commit
       # Ruff version.
-      rev: v0.12.0
+      rev: v0.15.6
       hooks:
           # Run the linter.
           - id: ruff
@@ -42,7 +40,7 @@ repos:
             types_or: [python, pyi, jupyter]
 
     - repo: https://github.com/pycqa/isort
-      rev: 6.0.1
+      rev: 8.0.1
       hooks:
           - id: isort
             name: isort (python)
@@ -54,13 +52,13 @@ repos:
             types: [pyi]
 
     - repo: https://github.com/pappasam/toml-sort
-      rev: v0.24.2
+      rev: v0.24.3
       hooks:
           - id: toml-sort-fix
             args: [--in-place, --spaces-indent-inline-array, '4']
 
     - repo: https://github.com/adrienverge/yamllint.git
-      rev: v1.37.1
+      rev: v1.38.0
       hooks:
           - id: yamllint
             args: [--format, parsable, --strict]
@@ -77,23 +75,23 @@ repos:
             args: [-s, bash]
 
     - repo: https://github.com/lovesegfault/beautysh
-      rev: v6.2.1
+      rev: v6.4.3
       hooks:
           - id: beautysh
             args: [--indent-size, '4']
 
     - repo: https://github.com/asottile/blacken-docs
-      rev: 1.19.1
+      rev: 1.20.0
       hooks:
           - id: blacken-docs
 
     - repo: https://github.com/asottile/pyupgrade
-      rev: v3.20.0
+      rev: v3.21.2
       hooks:
           - id: pyupgrade
 
     - repo: https://github.com/commitizen-tools/commitizen
-      rev: v4.8.3
+      rev: v4.13.9
       hooks:
           - id: commitizen
             stages: [commit-msg]

{hydrotoolbox-2.0.14 → hydrotoolbox-2.2.0}/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 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
+
+- complete revamp of baseflow_sep using scipy.lfilter for most
+
 ## v2.0.14 (2025-06-29)
 
 ### Fix

{hydrotoolbox-2.0.14/src/hydrotoolbox.egg-info → hydrotoolbox-2.2.0}/PKG-INFO

@@ -1,36 +1,36 @@
 Metadata-Version: 2.4
 Name: hydrotoolbox
-Version: 2.0.14
+Version: 2.2.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
+Project-URL: bitbucket, https://bitbucket.org/timcera/hydrotoolbox/src/main/
 Project-URL: documentation, https://timcera.bitbucket.io/hydrotoolbox/docs/index.html#hydrotoolbox-documentation
 Project-URL: github, https://github.com/timcera/hydrotoolbox
-Project-URL: bitbucket, https://bitbucket.org/timcera/hydrotoolbox/src/main/
-Keywords: time-series,cli-app,hydrology,baseflow,hydrograph-recession,hydrographic
+Keywords: baseflow,cli-app,hydrograph-recession,hydrographic,hydrology,time-series
 Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Science/Research
-Classifier: Intended Audience :: End Users/Desktop
-Classifier: Intended Audience :: Developers
 Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Requires-Dist: cltoolbox>=1.0.0
 Requires-Dist: dateparser
-Requires-Dist: numpy<2.0; python_version == "3.9"
+Requires-Dist: numpy
 Requires-Dist: pandas[excel]
 Requires-Dist: pint!=0.21.*
 Requires-Dist: pint-pandas
@@ -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.0.14 → hydrotoolbox-2.2.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.2.0/VERSION

@@ -0,0 +1 @@
+2.2.0

{hydrotoolbox-2.0.14 → hydrotoolbox-2.2.0}/docs/command_line.rst

@@ -27,9 +27,9 @@ baseflow_sep chapman
 .. program-output:: hydrotoolbox baseflow_sep chapman --help
    :prompt:
 
-baseflow_sep cm
----------------
-.. program-output:: hydrotoolbox baseflow_sep cm --help
+baseflow_sep chapman_maxwell
+----------------------------
+.. program-output:: hydrotoolbox baseflow_sep chapman_maxwell --help
    :prompt:
 
 baseflow_sep eckhardt
@@ -57,14 +57,9 @@ baseflow_sep ihacres
 .. program-output:: hydrotoolbox baseflow_sep ihacres --help
    :prompt:
 
-baseflow_sep lh
----------------
-.. program-output:: hydrotoolbox baseflow_sep lh --help
-   :prompt:
-
-baseflow_sep strict
--------------------
-.. program-output:: hydrotoolbox baseflow_sep strict --help
+baseflow_sep lyne_hollick
+-------------------------
+.. program-output:: hydrotoolbox baseflow_sep lyne_hollick --help
    :prompt:
 
 baseflow_sep ukih

{hydrotoolbox-2.0.14 → hydrotoolbox-2.2.0}/docs/function_summary.rst

@@ -9,14 +9,13 @@ Python API Function Summary
     hydrotoolbox.about
     hydrotoolbox.baseflow_sep.boughton
     hydrotoolbox.baseflow_sep.chapman
-    hydrotoolbox.baseflow_sep.cm
+    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.lh
-    hydrotoolbox.baseflow_sep.strict
+    hydrotoolbox.baseflow_sep.lyne_hollick
     hydrotoolbox.baseflow_sep.ukih
     hydrotoolbox.baseflow_sep.usgs_hysep_fixed
     hydrotoolbox.baseflow_sep.usgs_hysep_local

{hydrotoolbox-2.0.14 → hydrotoolbox-2.2.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.0.14 → hydrotoolbox-2.2.0}/pyproject.toml

@@ -1,73 +1,71 @@
 [build-system]
 build-backend = "setuptools.build_meta"
 requires = [
-    "setuptools>=45",
-    "setuptools_scm[toml]>=6.2",
-    "wheel"
+    "setuptools-scm[simple]>=8",
+    "setuptools>=80"
 ]
 
 [project]
-name = "hydrotoolbox"
-dynamic = ["version"]
-readme = "README.rst"
-description = "Command line script and Python library for analysis of flow time-series."
-dependencies = [
-    "cltoolbox >= 1.0.0",
-    "dateparser",
-    "numpy <2.0; python_version == '3.9'",
-    "pandas[excel]",
-    "pint!=0.21.*",
-    "pint-pandas",
-    "pydantic",
-    "scipy",
-    "tabulate"
-]
 authors = [
-    {name = "Tim Cera", email = "tim@cerazone.net"}
+    {email = "tim@cerazone.net", name = "Tim Cera"}
 ]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
-    "Intended Audience :: Science/Research",
-    "Intended Audience :: End Users/Desktop",
-    "Intended Audience :: Developers",
     "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "Intended Audience :: Science/Research",
     "License :: OSI Approved :: BSD License",
     "Natural Language :: English",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Topic :: Scientific/Engineering :: Information Analysis",
     "Topic :: Scientific/Engineering",
     "Topic :: Software Development :: Libraries :: Python Modules"
+] # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
+dependencies = [
+    "cltoolbox >= 1.0.0",
+    "dateparser",
+    "numpy",
+    "pandas[excel]",
+    "pint!=0.21.*",
+    "pint-pandas",
+    "pydantic",
+    "scipy",
+    "tabulate"
 ]
+description = "Command line script and Python library for analysis of flow time-series."
+dynamic = ["readme", "version"]
 keywords = [
-    "time-series",
-    "cli-app",
-    "hydrology",
     "baseflow",
+    "cli-app",
     "hydrograph-recession",
-    "hydrographic"
+    "hydrographic",
+    "hydrology",
+    "time-series"
 ]
 license = {text = "BSD-3-Clause"}
-requires-python = ">=3.9"
+name = "hydrotoolbox"
+requires-python = ">=3.10"
 
 [project.scripts]
 hydrotoolbox = "hydrotoolbox.hydrotoolbox:main"
 
 [project.urls]
+bitbucket = "https://bitbucket.org/timcera/hydrotoolbox/src/main/"
 documentation = "https://timcera.bitbucket.io/hydrotoolbox/docs/index.html#hydrotoolbox-documentation"
 github = "https://github.com/timcera/hydrotoolbox"
-bitbucket = "https://bitbucket.org/timcera/hydrotoolbox/src/main/"
 
 [tool.commitizen]
 name = "cz_conventional_commits"
 tag_format = "v$version"
 update_changelog_on_bump = true
-version = "2.0.14"
+version = "2.2.0"
 version_files = ["VERSION"]
 
 [tool.isort]
@@ -77,8 +75,8 @@ profile = "black"
 testpaths = ["tests"]
 
 [tool.setuptools]
-license-files = ["LICENSE.txt"]
 include-package-data = true
+license-files = ["LICENSE.txt"]
 
 [tool.setuptools.dynamic]
 readme = {file = "README.rst"}
@@ -86,5 +84,3 @@ version = {file = "VERSION"}
 
 [tool.setuptools.packages.find]
 where = ["src"]
-
-[tool.setuptools_scm]

{hydrotoolbox-2.0.14 → hydrotoolbox-2.2.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.0.14 → hydrotoolbox-2.2.0}/src/hydrotoolbox/baseflow/__init__.py

@@ -3,14 +3,14 @@ import os
 __all__ = [
     "boughton",
     "chapman",
-    "cm",
+    "chapman_maxwell",
     "eckhardt",
     "ewma",
     "five_day",
     "fixed",
     "furey",
     "ihacres",
-    "lh",
+    "lyne_hollick",
     "local",
     "slide",
     "strict",
@@ -29,15 +29,15 @@ from .comparison import KGE, strict_baseflow
 from .methods import (
     boughton,
     chapman,
-    cm,
+    chapman_maxwell,
     eckhardt,
     ewma,
     five_day,
     fixed,
     furey,
     ihacres,
-    lh,
     local,
+    lyne_hollick,
     slide,
     strict,
     ukih,

{hydrotoolbox-2.0.14 → hydrotoolbox-2.2.0}/src/hydrotoolbox/baseflow/comparison.py

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

{hydrotoolbox-2.0.14 → hydrotoolbox-2.2.0}/src/hydrotoolbox/baseflow/methods/__init__.py

@@ -1,14 +1,14 @@
 __all__ = [
     "boughton",
     "chapman",
-    "cm",
+    "chapman_maxwell",
     "eckhardt",
     "ewma",
     "five_day",
     "fixed",
     "furey",
     "ihacres",
-    "lh",
+    "lyne_hollick",
     "local",
     "slide",
     "strict",
@@ -22,15 +22,15 @@ __all__ = [
 
 from .boughton import boughton, f_Boughton
 from .chapman import chapman
-from .cm import cm
+from .chapman_maxwell import chapman_maxwell
 from .eckhardt import eckhardt, f_Eckhardt
 from .ewma import ewma
 from .five_day import five_day
 from .fixed import fixed
 from .furey import f_Furey, furey
 from .ihacres import ihacres
-from .lh import lh
 from .local import local
+from .lyne_hollick import lyne_hollick
 from .slide import slide
 from .strict import strict
 from .ukih import ukih

hydrotoolbox-2.2.0/src/hydrotoolbox/baseflow/methods/boughton.py

@@ -0,0 +1,21 @@
+__all__ = [
+    "boughton",
+]
+
+from hydrotoolbox.baseflow.methods.general_form import general_form_digital_filter
+
+
+def boughton(flow, k, C):
+    """Boughton double-parameter filter (Boughton, 2004)"""
+    alpha = k / (1 + C)
+    beta = C / (1 + C)
+    gamma = 0.0
+
+    return general_form_digital_filter(flow, alpha, beta, gamma)
+
+
+def f_Boughton(k):
+    def _Boughton(Q, C):
+        return boughton(Q, k, C)
+
+    return _Boughton

hydrotoolbox-2.2.0/src/hydrotoolbox/baseflow/methods/chapman.py

@@ -0,0 +1,14 @@
+__all__ = [
+    "chapman",
+]
+
+from hydrotoolbox.baseflow.methods.general_form import general_form_digital_filter
+
+
+def chapman(flow, k):
+    """Chapman filter (Chapman, 1991)"""
+    alpha = (3 * k - 1) / (3 - k)
+    beta = (1 - k) / (3 - k)
+    gamma = 1.0
+
+    return general_form_digital_filter(flow, alpha, beta, gamma)

hydrotoolbox-2.2.0/src/hydrotoolbox/baseflow/methods/chapman_maxwell.py

@@ -0,0 +1,14 @@
+__all__ = [
+    "chapman_maxwell",
+]
+
+from hydrotoolbox.baseflow.methods.general_form import general_form_digital_filter
+
+
+def chapman_maxwell(flow, k):
+    """CM filter (Chapman & Maxwell, 1996)"""
+    alpha = k / (2 - k)
+    beta = (1 - k) / (2 - k)
+    gamma = 0
+
+    return general_form_digital_filter(flow, alpha, beta, gamma)

hydrotoolbox-2.2.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.0.14 → hydrotoolbox-2.2.0}/src/hydrotoolbox/baseflow/methods/ewma.py

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

{hydrotoolbox-2.0.14 → hydrotoolbox-2.2.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.0.14 → hydrotoolbox-2.2.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):