pthelma 2.0.0__tar.gz → 2.1.0__tar.gz

{pthelma-2.0.0 → pthelma-2.1.0}/.github/workflows/run-tests.yml

@@ -37,6 +37,7 @@ jobs:
 
     - name: Install Dependencies
       run: |
+        sudo apt-get update
         sudo apt-get install -y gdal-bin libgdal-dev postgresql-14-postgis-3
         source ~/.venv/bin/activate
         # numpy<2 is needed for gdal to contain support for gdal array

{pthelma-2.0.0 → pthelma-2.1.0}/CHANGELOG.rst

@@ -2,6 +2,14 @@
 Changelog
 =========
 
+
+2.1.0 (2025-01-10)
+==================
+
+* haggregate: The ``missing_flag`` parameter to ``aggregate()`` can now
+  include the substring "{}", which will be replaced with the number of
+  missing values.
+
 2.0.0 (2024-12-04)
 ==================
 

{pthelma-2.0.0/src/pthelma.egg-info → pthelma-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pthelma
-Version: 2.0.0
+Version: 2.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>

{pthelma-2.0.0 → pthelma-2.1.0}/docs/haggregate/api.rst

@@ -34,7 +34,14 @@ haggregate API
    than *min_count* source records corresponding, the resulting
    destination record is null; otherwise, the destination record is
    derived even though some records are missing.  In that case, the flag
-   specified by *missing_flag* is raised in the destination record.
+   specified by *missing_flag* is raised in the destination record. If
+   missing flag contains the string ``{}``, it is replaced with the
+   number of missing records. The recommended setting for *missing_flag*
+   is ``MISSING{}``, which, for example, will result in ``MISSING3``
+   when three records are missing. The default for *missing_flag* is
+   ``MISS`` for backwards compatibility (it was ``MISS`` for some years,
+   however this was undocumented), but this is deprecated; use
+   ``MISSING{}``.
 
    If an error occurs, such as *ts* not having a strictly regular step,
    :exc:`AggregateError` (or a subclass) is raised.

{pthelma-2.0.0 → pthelma-2.1.0}/docs/haggregate/usage.rst

@@ -55,7 +55,7 @@ explanatory comments that follow it:
     base_dir = /var/cache/timeseries/
     target_step = 1h
     min_count = 2
-    missing_flag = DATEINSERT
+    missing_flag = MISSING{}
 
     [temperature]
     source_file = temperature-10min.hts
@@ -133,7 +133,8 @@ General parameters
    to a destination record, the resulting destination record is null;
    otherwise, the destination record is derived even though some records
    are missing. In that case, the flag specified by
-   :option:`missing_flag` is raised in the destination record.
+   :option:`missing_flag` is raised in the destination record. See
+   :meth:`~haggregate.aggregate` for details on :option:`missing_flag`.
 
 Time series sections
 --------------------

{pthelma-2.0.0 → pthelma-2.1.0}/src/haggregate/haggregate.py

@@ -75,8 +75,8 @@ class Aggregation:
     def get_result_flags(self):
         max_count = int(pd.Timedelta(self.result.time_step) / self.source.freq)
         values_count = self.resampler.count()
-        self.result.data["flags"] = (values_count < max_count).apply(
-            lambda x: self.missing_flag if x else ""
+        self.result.data["flags"] = (max_count - values_count).apply(
+            lambda x: self.missing_flag.format(x) if x else ""
         )