pthelma 1.0.0__tar.gz → 1.1.0__tar.gz

{pthelma-1.0.0 → pthelma-1.1.0}/.github/workflows/build_wheels.yml

@@ -1,15 +1,10 @@
 name: Build wheels
 
 on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
   release:
     types:
       - published
+  workflow_dispatch:
 
 jobs:
   build_wheels:

{pthelma-1.0.0 → pthelma-1.1.0}/.github/workflows/run-tests.yml

@@ -1,4 +1,4 @@
-name: Run tests
+name: Tests
 
 on:
   push:

{pthelma-1.0.0 → pthelma-1.1.0}/.gitignore

@@ -40,3 +40,4 @@ _version.py
 
 # cython
 src/haggregate/regularize.c
+src/rocc/calculation.c

{pthelma-1.0.0 → pthelma-1.1.0}/CHANGELOG.rst

@@ -2,6 +2,11 @@
 Changelog
 =========
 
+1.1.0 (2024-12-01)
+==================
+
+Added package rocc (equivalent to rocc 3.0).
+
 1.0.0 (2024-11-29)
 ==================
 

{pthelma-1.0.0/src/pthelma.egg-info → pthelma-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pthelma
-Version: 1.0.0
+Version: 1.1.0
 Summary: Utilities for hydrological and meteorological time series processing
 Author-email: Antonis Christofides <antonis@antonischristofides.com>
 Maintainer-email: Antonis Christofides <antonis@antonischristofides.com>
@@ -34,9 +34,9 @@ Requires-Dist: gdal<4,>=1.10; extra == "all"
 pthelma
 =======
 
-.. image:: https://github.com/openmeteo/pthelma/actions/workflows/run-tests-automatically.yml/badge.svg
+.. image:: https://github.com/openmeteo/pthelma/actions/workflows/run-tests.yml/badge.svg
     :alt: Build button
-    :target: https://github.com/openmeteo/pthelma/actions/workflows/run-tests-automatically.yml
+    :target: https://github.com/openmeteo/pthelma/actions/workflows/run-tests.yml
 
 .. image:: https://codecov.io/github/openmeteo/pthelma/coverage.svg?branch=master
     :alt: Coverage
@@ -45,10 +45,6 @@ pthelma
 .. image:: https://img.shields.io/pypi/v/pthelma.svg
         :target: https://pypi.python.org/pypi/pthelma
 
-.. image:: https://pyup.io/repos/github/openmeteo/pthelma/shield.svg
-         :target: https://pyup.io/repos/github/openmeteo/pthelma/
-         :alt: Updates
-
 A Python library with utilities for hydrological and meteorological time
 series processing.
 

{pthelma-1.0.0 → pthelma-1.1.0}/README.rst

@@ -1,9 +1,9 @@
 pthelma
 =======
 
-.. image:: https://github.com/openmeteo/pthelma/actions/workflows/run-tests-automatically.yml/badge.svg
+.. image:: https://github.com/openmeteo/pthelma/actions/workflows/run-tests.yml/badge.svg
     :alt: Build button
-    :target: https://github.com/openmeteo/pthelma/actions/workflows/run-tests-automatically.yml
+    :target: https://github.com/openmeteo/pthelma/actions/workflows/run-tests.yml
 
 .. image:: https://codecov.io/github/openmeteo/pthelma/coverage.svg?branch=master
     :alt: Coverage
@@ -12,10 +12,6 @@ pthelma
 .. image:: https://img.shields.io/pypi/v/pthelma.svg
         :target: https://pypi.python.org/pypi/pthelma
 
-.. image:: https://pyup.io/repos/github/openmeteo/pthelma/shield.svg
-         :target: https://pyup.io/repos/github/openmeteo/pthelma/
-         :alt: Updates
-
 A Python library with utilities for hydrological and meteorological time
 series processing.
 

{pthelma-1.0.0 → pthelma-1.1.0}/docs/index.rst

@@ -29,6 +29,7 @@ pthelma - Utilities for hydrological and meteorological time series processing
 
    haggregate/usage
    haggregate/api
+   rocc
 
 
 .. toctree::

pthelma-1.1.0/docs/rocc.rst

@@ -0,0 +1,77 @@
+===========================================
+rocc - Rate-of-change check for time series
+===========================================
+
+.. class:: Threshold
+
+   A named tuple whose items are :attr:`delta_t` (a pandas interval
+   specification) and :attr:`allowed_diff` (a floating point number).
+
+.. function:: rocc.rocc(ahtimeseries, thresholds, symmetric=False, flag="TEMPORAL")
+
+   Example ::
+
+      from rocc import Threshold, rocc
+
+      result = rocc(
+         timeseries=a_htimeseries_object,
+         thresholds=(
+            Threshold("10min", 10),
+            Threshold("20min", 15),
+            Threshold("H", 40),
+         ),
+         symmetric=True,
+         flag="MYFLAG",
+      )
+
+   ``timeseries`` is a :class:`HTimeseries` object.  ``thresholds`` is
+   a list of :class:`Threshold` objects.
+
+   The function checks whether there exist intervals during which the
+   value of the time series changes by more than the specified
+   threshold. The offending records are flagged with the specified
+   ``flag``.
+
+   It returns a list of strings describing where the thresholds have been
+   exceeded.
+
+   If ``flag`` is ``None`` or the empty string, then the offending records
+   are not flagged, and the only result is the returned value.
+
+   Here is an example time series::
+
+      2020-10-06 14:30    24.0
+      2020-10-06 14:40    25.0  
+      2020-10-06 14:50    36.0 *
+      2020-10-06 15:01    51.0
+      2020-10-06 15:21    55.0  
+      2020-10-06 15:31    65.0  
+      2020-10-06 15:41    75.0 *
+      2020-10-06 15:51    70.0
+
+   After running ``rocc()`` with the ``thresholds`` specified in the
+   example above, the records marked with a star will be flagged. The
+   record ``14:50`` will be flagged because in the preceding 10-minute
+   interval the value increases by 11, which is more than 10. The record
+   ``15:41`` will be flagged because in the preceding 20-minute interval
+   the value increases by 20, which is more than 15. The record ``15:01``
+   will be unflagged; although there's a large difference since ``14:40``,
+   this is 21 minutes, not 20, so the 20-minute threshold of 15 does not
+   apply; likewise, there's a difference of 15 from ``14:50``, which does
+   not exceed the 20-minute threshold of 15, and while it does exceed the
+   10-minute threshold of 10, it's 11 minutes, not 10. There's also not any
+   difference larger than 40 within an hour anywhere.
+
+   The return value in this example will be a list of two strings::
+
+      "2020-10-06T14:50  +11.0 in 10min (> 10.0)"
+      "2020-10-06T15:41  +20.0 in 20min (> 15.0)"
+
+   The return value should only be used for consumption by humans; it is
+   subject to change.
+
+   If ``symmetric`` is ``True``, it is the absolute value of the change
+   that matters, not its direction. In this case, ``allowed_diff`` must be
+   positive. If ``symmetric`` is ``False`` (the default), only rates larger
+   than positive ``allow_diff`` or rates smaller than negative
+   ``allow_diff`` are flagged.

{pthelma-1.0.0 → pthelma-1.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
 # numpy<2 is not just a dependency, it's a build dependency, because it's
-# needed to build regularize.pyx (and the _gdal_array thing, which gdal won't
+# needed to build some .pyx files (and the _gdal_array thing, which gdal won't
 # build if numpy is not available at build time). It's at "<2" because of gdal;
 # pthelma can also use ">=2".
 requires = ["setuptools>=61.0", "setuptools-scm>=7.1", "cython", "numpy<2"]

pthelma-1.1.0/setup.py

@@ -0,0 +1,20 @@
+import numpy
+from Cython.Build import cythonize
+from setuptools import Extension, setup
+
+setup(
+    ext_modules=cythonize(
+        [
+            Extension(
+                "haggregate.regularize",
+                sources=["src/haggregate/regularize.pyx"],
+                include_dirs=[numpy.get_include()],
+            ),
+            Extension(
+                "rocc.calculation",
+                sources=["src/rocc/calculation.pyx"],
+                include_dirs=[numpy.get_include()],
+            ),
+        ]
+    ),
+)

pthelma-1.1.0/src/haggregate/__init__.py

@@ -0,0 +1,2 @@
+from .haggregate import *  # NOQA
+from .regularize import *  # NOQA