pthelma 0.14.0__tar.gz → 0.99.3.dev0__tar.gz

pthelma-0.99.3.dev0/.github/workflows/build_wheels.yml

@@ -0,0 +1,57 @@
+name: Build wheels
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  release:
+    types:
+      - published
+
+jobs:
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v2.22.0
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
+          path: ./wheelhouse/*.whl
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build sdist
+        run: pipx run build --sdist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-sdist
+          path: dist/*.tar.gz
+
+  upload_pypi:
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-latest
+    environment: pypi
+    if: github.event_name == 'release' && github.event.action == 'published'
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: cibw-*
+          path: dist
+          merge-multiple: true
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

pthelma-0.99.3.dev0/.github/workflows/run-tests-automatically.yml

@@ -0,0 +1,64 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        include:
+          - python-version: "3.10"
+            include-codecov: false
+          - python-version: "3.11"
+            include-codecov: false
+          - python-version: "3.12"
+            include-codecov: true
+
+    steps:
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Create and activate venv
+      run: |
+        python -m venv ~/.venv
+        source ~/.venv/bin/activate
+        pip install -U pip 'setuptools>=61'
+
+    - uses: actions/checkout@v3
+
+    - name: Install Dependencies
+      run: |
+        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
+        pip install 'numpy<2'
+        CPLUS_INCLUDE_PATH=/usr/include/gdal C_INCLUDE_PATH=/usr/include/gdal pip install --no-build-isolation 'gdal==3.4.1'
+        pip install coverage isort flake8 'black<25' twine setuptools build
+        pip install -e .
+
+    - name: Run Tests
+      run: |
+        source ~/.venv/bin/activate
+        black --check .
+        flake8 --max-line-length=88 .
+        isort --check-only --diff --profile=black *.py .
+        python -m build
+        twine check dist/*
+        coverage run --include="./*" --omit="docs/","*/tests/*","_version.py","*.pyx" -m unittest -v
+        coverage json
+
+    - name: Upload coverage to Codecov
+      if: matrix.include-codecov == true
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

pthelma-0.99.3.dev0/.gitignore

@@ -0,0 +1,40 @@
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+man/loggertodb.1
+docs/_build
+
+# setuptools-scm
+_version.py

pthelma-0.99.3.dev0/.readthedocs.yaml

@@ -0,0 +1,14 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+

pthelma-0.99.3.dev0/CHANGELOG.rst

@@ -0,0 +1,11 @@
+=========
+Changelog
+=========
+
+1.0.0 (2024-11)
+===============
+
+This is a different pthelma from the old 0.14, which had been abandoned
+in favor of a number of separate packages. However, maintaining all
+these separate packages was too cumbersome and now we re-combine them
+here.

pthelma-0.99.3.dev0/LICENSE.rst

@@ -0,0 +1,34 @@
+===================
+License and credits
+===================
+
+| Copyright (C) 2013-2018 TEI of Epirus
+| Copyright (C) 2014-2016 Antonis Christofides
+| Copyright (C) 2019  University of Ioannina
+| Copyright (C) 2018-2021 National Technical University of Athens
+| Copyright (C) 2018-2021 Institute of Communications and Computer Systems
+| Copyright (C) 2022-2024 IRMASYS P.C.
+
+pthelma is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation, either version 3 of the License, or (at your
+option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Pthelma was funded by several organizations:
+
+* In 2013-2018 by the `TEI of Epirus`_ as part of the IRMA_ project.
+* In 2018-2021 by NTUA_ and ICCS_ as part of the OpenHi_ project.
+
+.. _ntua: http://www.ntua.gr/
+.. _tei of epirus: http://www.teiep.gr/en/
+.. _irma: http://www.irrigation-management.eu/
+.. _iccs: https://www.iccs.gr
+.. _openhi: https://openhi.net

pthelma-0.99.3.dev0/MANIFEST.in

@@ -0,0 +1,9 @@
+include CHANGELOG.rst
+include LICENSE.rst
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

pthelma-0.99.3.dev0/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.1
+Name: pthelma
+Version: 0.99.3.dev0
+Summary: Utilities for hydrological and meteorological time series processing
+Author-email: Antonis Christofides <antonis@antonischristofides.com>
+Maintainer-email: Antonis Christofides <antonis@antonischristofides.com>
+Project-URL: Homepage, https://github.com/openmeteo/pthelma
+Project-URL: Documentation, https://pthelma.readthedocs.io
+Project-URL: Repository, https://github.com/openmeteo/pthelma
+Project-URL: Changelog, https://github.com/openmeteo/pthelma/blob/master/CHANGELOG.rst
+Keywords: time series
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE.rst
+Requires-Dist: pandas<3,>=2.2
+Requires-Dist: iso8601<3,>=2.1
+Requires-Dist: textbisect<1,>=0.1
+Requires-Dist: tzdata
+Requires-Dist: Click<9,>=7.0
+Requires-Dist: simpletail<2,>=1
+Requires-Dist: affine<3,>=2.4
+Requires-Dist: gdal<4,>=1.10
+Requires-Dist: django<6,>=3.2
+Requires-Dist: requests<3,>=1
+
+pthelma
+=======
+
+.. image:: https://github.com/openmeteo/pthelma/actions/workflows/run-tests-automatically.yml/badge.svg
+    :alt: Build button
+    :target: https://github.com/openmeteo/pthelma/actions/workflows/run-tests-automatically.yml
+
+.. image:: https://codecov.io/github/openmeteo/pthelma/coverage.svg?branch=master
+    :alt: Coverage
+    :target: https://codecov.io/gh/openmeteo/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.
+
+Documentation: https://pthelma.readthedocs.io

pthelma-0.99.3.dev0/README.rst

@@ -0,0 +1,22 @@
+pthelma
+=======
+
+.. image:: https://github.com/openmeteo/pthelma/actions/workflows/run-tests-automatically.yml/badge.svg
+    :alt: Build button
+    :target: https://github.com/openmeteo/pthelma/actions/workflows/run-tests-automatically.yml
+
+.. image:: https://codecov.io/github/openmeteo/pthelma/coverage.svg?branch=master
+    :alt: Coverage
+    :target: https://codecov.io/gh/openmeteo/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.
+
+Documentation: https://pthelma.readthedocs.io

pthelma-0.99.3.dev0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = pthelma
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pthelma-0.99.3.dev0/docs/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst

pthelma-0.99.3.dev0/docs/conf.py

@@ -0,0 +1,46 @@
+from setuptools_scm import get_version
+
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
+templates_path = ["_templates"]
+source_suffix = ".rst"
+master_doc = "index"
+project = "pthelma"
+copyright = "2024, IRMASYS"
+author = "Antonis Christofides"
+version = get_version(root="..")
+release = version
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+pygments_style = "sphinx"
+html_theme = "alabaster"
+html_static_path = ["_static"]
+htmlhelp_basename = "pthelma"
+latex_elements = {}
+latex_documents = [
+    (
+        master_doc,
+        "pthelma.tex",
+        "pthelma Documentation",
+        "Antonis Christofides",
+        "manual",
+    )
+]
+texinfo_documents = [
+    (
+        master_doc,
+        "pthelma",
+        "pthelma Documentation",
+        author,
+        "pthelma",
+        "Utilities for hydrological and meteorological time series processing",
+        "Miscellaneous",
+    )
+]
+
+
+def setup(app):
+    app.add_object_type(
+        "confval",
+        "confval",
+        objname="configuration value",
+        indextemplate="pair: %s; configuration value",
+    )

pthelma-0.99.3.dev0/docs/enhydris_api_client.rst

@@ -0,0 +1,95 @@
+====================================================
+enhydris-api-client - Python client for Enhydris API
+====================================================
+
+Example
+=======
+
+::
+
+    from enhydris_api_client import EnhydrisApiClient
+
+    with EnhydrisApiClient("https://openmeteo.org", "my_auth_token") as api_client:
+        # Get a dict with attrs of station with id=42
+        station = api_client.get_model(Station, 42)
+
+        # Create a new station
+        api_client.post_model(Station, data={"name": "my station"})
+
+
+Reference
+=========
+
+``from enhydris_api_client import EnhydrisApiClient``
+
+.. class:: EnhydrisApiClient(base_url, token=None)
+
+   Creates and returns an api client. It can also be used as a context
+   manager, though this is not necessary. If not used as a context
+   manager, you might get warnings about unclosed sockets.
+
+   Not specifying ``token`` is deprecated. ``token`` will become
+   mandatory in future versions.
+
+   .. method:: get_token(self, username, password)
+
+      (Deprecated.) Gets an API token from Enhydris and thereafter uses
+      it in subsequent requests. The method will be removed in future
+      versions.
+
+   .. method:: get_station(self, id)
+               post_station(self, data)
+               put_station(self, station_id, data)
+               patch_station(self, station_id, data)
+               delete_station(self, station_id)
+
+      Methods that create, retrieve, update or delete stations. The
+      ``data`` argument (for those methods that receive one) is a
+      dictionary.  :meth:`~EnhydrisApiClient.get_station` returns a
+      dictionary with the data for the station.
+      ``~EnhydrisApiClient.post_station`` returns the created station's
+      id.
+
+   .. method:: get_timeseries_group(self, station_id, timeseries_group_id)
+               post_timeseries_group(self, station_id, timeseries_group_id, data)
+               put_timeseries_group(self, station_id, timeseries_group_id, data)
+               patch_timeseries_group(self, station_id, timeseries_group_id, data)
+               delete_timeseries_group(self, station_id, timeseries_group_id)
+
+      Methods that create, retrieve, update or delete time series
+      groups.  Similar to the ones for station.
+
+   .. method:: list_timeseries(self, station_id, timeseries_group_id)
+               get_timeseries(self, station_id, timeseries_group_id, timeseries_id)
+               post_timeseries(self, station_id, timeseries_group_id, data)
+               delete_timeseries(self, station_id, timeseries_group_id, timeseries_id)
+
+      Methods that create, retrieve or delete time series. Similar to
+      the ones for station. :meth:`~EnhydrisApiClient.list_timeseries`
+      returns a list of dictionaries.
+
+   .. method:: read_tsdata(self, station_id, timeseries_group_id, timeseries_id, start_date=None, end_date=None, timezone=None)
+              .post_tsdata(self, station_id, timeseries_group_id, timeseries_id, ts)
+              .get_ts_end_date(self, station_id, timeseries_group_id, timeseries_id, timezone=None)
+
+      Methods that retrieve or update time series data.
+
+      :meth:`~EnhydrisApiClient.read_ts_data` retrieves the time series
+      data into a htimeseries object that it returns. If ``start_date``
+      and/or ``end_date`` (aware datetime objects) are specified, only
+      the part of the time series between these dates is retrieved. The
+      timestamps are returned in the specified time zone. If
+      unspecified, then they are returned in the time zone specified by
+      the station's display_timezone_.
+
+      :meth:`~EnhydrisApiClient.post_tsdata` posts a time series to
+      Enhydris, appending the records to any already existing.  ``ts``
+      is a :class:`HTimeseries` object.
+
+      :meth:`~EnhydrisApiClient.get_ts_end_date` returns a ``datetime``
+      object which is the last timestamp of the time series. If the time
+      series is empty it returns ``None``. The returned timestamp is
+      always naive, but it is in the specified ``timezone`` (or the
+      station's display_timezone_ if unspecified).
+
+      .. _display_timezone: https://enhydris.readthedocs.io/en/latest/dev/database.html#enhydris.models.Gentity.display_timezone

pthelma-0.99.3.dev0/docs/enhydris_cache/api.rst

@@ -0,0 +1,22 @@
+.. _enhydris_cache_api:
+
+==================
+enhydris-cache API
+==================
+
+``import enhydris_cache``
+
+.. class:: enhydris_cache.TimeseriesCache(timeseries_groups)
+  
+   Keeps certain time series cached in the filesystem. The time series
+   is downloaded from Enhydris using the Enhydris web service API.
+   *timeseries_groups* is a list; each item is a dictionary
+   representing an Enhydris time series; its keys are *base_url*,
+   *auth_token*, *id*, and *file*; the latter is the filename of
+   the file to which the time series will be cached (absolute or
+   relative to the current working directory).
+
+   .. method:: update()
+
+      Downloads everything that has not already been downloaded (or all
+      the time series if nothing is in the cache).

pthelma-0.99.3.dev0/docs/enhydris_cache/usage.rst

@@ -0,0 +1,143 @@
+==========================================================
+enhydris-cache - keep copies of time series in local files
+==========================================================
+
+Synopsis
+========
+
+``enhydris_cache [--traceback] config_file``
+
+Description and quick start
+===========================
+
+``enhydris-cache`` downloads data from Enhydris and stores them
+locally in the file system.  The details of its operation are
+specified in the configuration file specified on the command line.
+
+How to run it
+-------------
+
+First, you need to create a configuration file with a text editor such
+as ``vim``, ``emacs``, ``notepad``, or whatever. Create such a file
+and name it, for example, :file:`/var/tmp/enhydris_cache.conf`,
+with the following contents (the contents don't matter at this stage,
+just copy and paste them from below)::
+
+    [General]
+    loglevel = INFO
+
+Then, open a command prompt and give it this command::
+
+    enhydris-cache /var/tmp/enhydris_cache.conf
+
+If you have done everything correctly, it should output an error message
+complaining that something in its configuration file isn't right.
+
+Configuration file example
+--------------------------
+
+Take a look at the following example configuration file and read the
+explanatory comments that follow it:
+
+.. code-block:: ini
+
+    [General]
+    loglevel = INFO
+    logfile = /var/log/enhydris-cache/enhydris-cache.log
+    cache_dir = /var/cache/enhydris-cache
+
+    [ntua]
+    base_url = https://openmeteo.org/
+    station_id = 1334
+    timeseries_group_id = 4321
+    timeseries_id = 6539
+    file = ntua.hts
+
+    [nedontas]
+    base_url = https://openmeteo.org/
+    station_id = 1482
+    timeseries_group_id = 1234
+    timeseries_id = 9356
+    file = /somewhere/else/nedontas.hts
+
+    [arta]
+    base_url = https://upatras.gr/enhydris/
+    auth_token = 123456789abcdef0123456789abcdef012345678
+    station_id = 27
+    timeseries_group_id = 2727
+    timeseries_id = 8765
+    file = arta.hts
+
+With the above configuration file, ``enhydris_cache`` will log
+information in the file specified by :confval:`logfile`. It will
+download time series from Enhydris and store them in the specified
+files; these can be absolute or relative pathnames; if they are
+relative, they will be stored in the directory specified by
+:confval:`cache_dir`. In this example, the local files will be
+:file:`/var/cache/enhydris-cache/ntua.hts`,
+:file:`/somewhere/else/enhydris-cache/nedontas.hts`, and
+:file:`/var/cache/enhydris-cache/arta.hts`.
+
+Configuration file reference
+============================
+
+The configuration file has the format of INI files. There is a
+``[General]`` section with general parameters, and any number of other
+sections, which we will call "time series sections", each time series
+section referring to one time series.
+
+General parameters
+------------------
+
+.. confval:: loglevel
+
+   Optional. Can have the values ``ERROR``, ``WARNING``, ``INFO``,
+   ``DEBUG``.  The default is ``WARNING``.
+
+.. confval:: logfile
+
+   Optional. The full pathname of a log file. If unspecified, log
+   messages will go to the standard error.
+
+.. confval:: cache_dir
+
+   Optional. ``enhydris_cache`` will change directory to this
+   directory, so any relative filenames will be relative to this
+   directory. If unspecified, relative filenames will be relative to
+   the directory from which ``enhydris_cache`` was started.
+
+Time series sections
+--------------------
+
+The name of the section is ignored.
+
+.. confval:: base_url
+
+   The base URL of the Enhydris installation that hosts the time
+   series.  Most often the :confval:`base_url` will be the same for
+   all time series, but in the general case you might want to get data
+   from many Enhydris installations.
+
+.. confval:: station_id
+
+   The id of the station.
+
+.. confval:: timeseries_group_id
+
+   The id of the time series group.
+
+.. confval:: timeseries_id
+
+   The id of the time series.
+
+.. confval:: auth_token
+
+   Optional.  Needed if that Enhydris installation needs login in
+   order to provide access to the data. You can get a token at the
+   ``/api/auth/login/`` URL of Enhydris, such as
+   https://openmeteo.org/api/auth/login/.
+
+.. confval:: file
+
+   The filename of the file to which the data will be cached. See also
+   :confval:`cache_dir`.