weatherdb 1.2.0__tar.gz → 1.2.1__tar.gz

{weatherdb-1.2.0 → weatherdb-1.2.1}/.gitlab-ci.yml

@@ -3,7 +3,7 @@ stages:
   - test_matrix
   - test_manual
   - build
-  - deploy
+  - release
 
 workflow:
   auto_cancel:
@@ -97,11 +97,11 @@ test_download_rasters:
       - PY_VERSION: ["3.9","3.10","3.11","3.12","3.13"]
 
 build:
+  stage: build
   rules:
-    - if: $CI_COMMIT_TAG =~ /^[Vv]\d+\.\d+\.\d+$/
+    - if: $CI_COMMIT_TAG =~ /^[Vv]*\d+\.\d+\.\d+$/
   dependencies:
     - test_matrix
-  stage: build
   image: python:3.11
   script:
     - python -m pip install --upgrade pip --root-user-action=ignore
@@ -115,12 +115,12 @@ build:
   tags:
     - docker
 
-deploy:
+release_pypi:
+  stage: release
   rules:
     - !reference [build, rules]
   dependencies:
     - build
-  stage: deploy
   image: python:3.11
   script:
     - python -m pip install --upgrade pip --root-user-action=ignore
@@ -131,4 +131,19 @@ deploy:
     TWINE_PASSWORD: $TWINE_PASSWORD
   tags:
     - docker
-  interruptible: false
+  interruptible: false
+
+release_gitlab:
+  stage: release
+  rules:
+    - !reference [build, rules]
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
+  dependencies:
+    - build
+    - release_pypi
+  script:
+    - echo "running release_gitlab"
+  release:
+    name: '$CI_COMMIT_TAG'
+    tag_name: '$CI_COMMIT_TAG'
+    description: '$CI_COMMIT_TAG_MESSAGE'

{weatherdb-1.2.0 → weatherdb-1.2.1}/CHANGES.md

@@ -1,7 +1,19 @@
 # Change-log
 
+## Version 1.2.1
+
+- fix: filllup linear regression did not take configuration value and therefor did never work
+- config: change LINEAR_INTERPOLATION_LIMIT to be a category
+- cli: add version parameter
+- multiprocessing: make process count configurable through user configuration
+- broker: prevent broker inactivation by other broker
+- broker: add force deactivate all method to forcefully change the database flag of active brokers
+
 ## Version 1.2.0
 
+> [!WARNING]
+> This versions update did have an error and the lienear regression doesn't work at all. PLease use version 1.2.1
+
 - tests: add test rasters and make downloading the rasters a manual job on GitLab as there were many problems
 - fillup: add method to linearly interpolate residual missing values
 
@@ -17,7 +29,10 @@
 
 ## Version 1.1.0
 
-- !!rename module from weatherDB to weatherdb to be compliant with PEP 8!!
+> [!NOTE]
+> **major change:** The module got renamed to `weatherdb`, you need to adapt this in your import and cli statements
+
+- rename module from weatherDB to weatherdb to be compliant with PEP 8
   So you need to import the module now with `import weatherdb`
 - fix some missing stationN variables to stationsP
 - fix: TimestampPeriod._check_period

{weatherdb-1.2.0 → weatherdb-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: weatherdb
-Version: 1.2.0
+Version: 1.2.1
 Summary: This is a package to work with and to create the Weather Database which handles, checks, fills and corrects DWD Weather Station data.
 Author-email: Max Schmit <max.schmit@hydrology.uni-freiburg.de>
 License:                     GNU GENERAL PUBLIC LICENSE

weatherdb-1.2.1/docs/source/api/weatherdb.broker.rst

@@ -0,0 +1,7 @@
+broker
+------
+
+.. autoclass:: weatherdb.broker.Broker
+
+
+

{weatherdb-1.2.0 → weatherdb-1.2.1}/docs/source/api/weatherdb.db.rst

@@ -19,5 +19,15 @@ base models
 
 .. autoclass:: weatherdb.db.models.MetaBaseQC
 
+views
+-----
 
+Those are the database views
+
+.. automodule:: weatherdb.db.views
+
+connections
+-----------
+
+.. automodule:: weatherdb.db.connections
 

{weatherdb-1.2.0 → weatherdb-1.2.1}/docs/source/api/weatherdb.rst

@@ -1,7 +1,6 @@
 weatherdb
 =========
 
-
 .. toctree::
    :maxdepth: 2
 

weatherdb-1.2.1/docs/source/api/weatherdb.station.GroupStation.rst

@@ -0,0 +1,5 @@
+GroupStation
+============
+
+.. py:module:: weatherdb.station
+.. autoclass:: weatherdb.station.GroupStation

weatherdb-1.2.1/docs/source/api/weatherdb.station.StationBases.rst

@@ -0,0 +1,18 @@
+StationBases
+============
+
+Those are the base station classes on which the real station classes above depend on.
+None of them is working on its own, because the class variables are not yet set correctly.
+
+.. py:module:: weatherdb.station.StationBases
+
+.. autoclass:: weatherdb.station.StationBases.StationBase
+
+
+.. autoclass:: weatherdb.station.StationBases.StationPBase
+
+
+.. autoclass:: weatherdb.station.StationBases.StationCanVirtualBase
+
+
+.. autoclass:: weatherdb.station.StationBases.StationTETBase

weatherdb-1.2.1/docs/source/api/weatherdb.station.StationET.rst

@@ -0,0 +1,5 @@
+StationET
+=========
+
+.. py:module:: weatherdb.station
+.. autoclass:: weatherdb.station.StationET

weatherdb-1.2.1/docs/source/api/weatherdb.station.StationP.rst

@@ -0,0 +1,5 @@
+StationP
+========
+
+.. py:module:: weatherdb.station
+.. autoclass:: weatherdb.station.StationP

weatherdb-1.2.1/docs/source/api/weatherdb.station.StationPD.rst

@@ -0,0 +1,6 @@
+StationPD
+=========
+
+.. py:module:: weatherdb.station
+.. autoclass:: weatherdb.station.StationPD
+  :exclude-members: quality_check, last_imp_quality_check, get_corr, get_adj, get_qc

weatherdb-1.2.1/docs/source/api/weatherdb.station.StationT.rst

@@ -0,0 +1,5 @@
+StationT
+========
+
+.. py:module:: weatherdb.station
+.. autoclass:: weatherdb.station.StationT

weatherdb-1.2.1/docs/source/api/weatherdb.station.rst

@@ -0,0 +1,17 @@
+station
+--------
+
+.. py:module:: weatherdb.station
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   weatherdb.station.StationP
+   weatherdb.station.StationT
+   weatherdb.station.StationET
+   weatherdb.station.StationPD
+   weatherdb.station.GroupStation
+   weatherdb.station.StationBases
+
+

weatherdb-1.2.1/docs/source/api/weatherdb.stations.StationsBase.rst

@@ -0,0 +1,15 @@
+StationsBase
+============
+
+Those are the base stations classes on which the real stations classes above depend on.
+None of them is working on its own, because the class variables are not yet set correctly.
+
+.. py:module:: weatherdb.stations.StationsBase
+
+.. autoclass:: weatherdb.stations.StationsBase.StationsBase
+
+  .. autoclasstoc::
+
+.. autoclass:: weatherdb.stations.StationsBaseTET.StationsBaseTET
+
+   .. autoclasstoc::

weatherdb-1.2.1/docs/source/api/weatherdb.stations.StationsET.rst

@@ -0,0 +1,6 @@
+StationsET
+==========
+
+.. py:module:: weatherdb.stations
+
+.. autoclass:: weatherdb.stations.StationsET

weatherdb-1.2.1/docs/source/api/weatherdb.stations.StationsP.rst

@@ -0,0 +1,6 @@
+StationsP
+=========
+
+.. py:module:: weatherdb.stations
+
+.. autoclass:: weatherdb.stations.StationsP

weatherdb-1.2.1/docs/source/api/weatherdb.stations.StationsPD.rst

@@ -0,0 +1,7 @@
+StationsPD
+==========
+
+.. py:module:: weatherdb.stations
+
+.. autoclass:: weatherdb.stations.StationsP
+

weatherdb-1.2.1/docs/source/api/weatherdb.stations.StationsT.rst

@@ -0,0 +1,7 @@
+StationsT
+=========
+
+.. py:module:: weatherdb.stations
+
+.. autoclass:: weatherdb.stations.StationsT
+

weatherdb-1.2.1/docs/source/api/weatherdb.stations.rst

@@ -0,0 +1,15 @@
+stations
+--------
+
+.. py:module:: weatherdb.stations
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   weatherdb.stations.StationsP
+   weatherdb.stations.StationsT
+   weatherdb.stations.StationsET
+   weatherdb.stations.StationsPD
+   weatherdb.stations.GroupStations
+   weatherdb.stations.StationsBase

{weatherdb-1.2.0 → weatherdb-1.2.1}/docs/source/api/weatherdb.utils.rst

@@ -3,6 +3,8 @@ utils
 
 In this module there are several utilities used by the WeatherDB package, you shouldn't need to use them directly.
 
+TimestampPeriod
+---------------
 .. autoclass:: weatherdb.utils.TimestampPeriod
 
 dwd

{weatherdb-1.2.0 → weatherdb-1.2.1}/docs/source/conf.py

@@ -84,6 +84,9 @@ autoclasstoc_sections = [
 # Autosummary options
 autosummary_generate = True
 autosummary_generate_overwrite = True
+suppress_warnings = [
+    'autosummary.import_cycle',
+]
 
 # intersphinx
 intersphinx_mapping = {

weatherdb-1.2.1/weatherdb/_version.py

@@ -0,0 +1 @@
+__version__ = "1.2.1"

{weatherdb-1.2.0 → weatherdb-1.2.1}/weatherdb/broker.py

@@ -647,8 +647,9 @@ class Broker(object):
         is_active : bool
             Whether the broker is active.
         """
+        if self._is_active != is_active:
+            self.set_setting("broker_active", str(is_active))
         self._is_active = is_active
-        self.set_setting("broker_active", str(is_active))
 
     def _deactivate(self):
         self.is_active = False
@@ -664,4 +665,13 @@ class Broker(object):
             yield self
         finally:
             self._deactivate()
-            atexit.unregister(self._deactivate)
+            atexit.unregister(self._deactivate)
+
+    def force_deactivate_all(self):
+        """Forcefully set the active broker flag in the database to deactivated.
+
+        This is useful if the broker got exited before it could deactivate itself.
+        """
+        if self.is_active:
+            self._deactivate()
+        self.set_setting("broker_active", "False")

{weatherdb-1.2.0 → weatherdb-1.2.1}/weatherdb/cli.py

@@ -16,6 +16,7 @@ import weatherdb
                  show_default=True
                  )
             )
+@click.version_option(weatherdb.__version__)
 @click.option('--do-logging/--no-logging',
               is_flag=True, default=True, show_default=True,
               help="Should the logging be done to the console?")
@@ -98,8 +99,11 @@ def create_user_config(file, on_exists):
 def download_ma_rasters(which, overwrite, update_user_config):
     """Get the multi annual rasters on which bases the regionalisation is done.
 
-    The refined multi annual datasets, that are downloaded are published on Zenodo:
-    Schmit, M.; Weiler, M. (2023). German weather services (DWD) multi annual meteorological rasters for the climate period 1991-2020 refined to 25m grid (1.0.0) [Data set]. Zenodo. https://doi.org/10.5281/zenodo.10066045
+    The refined multi annual datasets, that are downloaded are published on Zenodo. [1]_
+
+    References:
+    -----------
+    .. [1]  Schmit, M.; Weiler, M. (2023). German weather services (DWD) multi annual meteorological rasters for the climate period 1991-2020 refined to 25m grid (1.0.0) [Data set]. Zenodo. `DOI:10.5281/zenodo.10066045 <https://doi.org/10.5281/zenodo.10066045>`_
     """
     click.echo("starting downloading multi annual raster data")
     from weatherdb.utils.get_data import download_ma_rasters
@@ -127,7 +131,7 @@ def download_ma_rasters(which, overwrite, update_user_config):
               help="The service to use to download the DEM. Options are 'prism' or 'openTopography'. " +\
                    "You can use this option muultiple times to test both in the given order until the file could be downloaded.")
 def download_dem(out_dir, overwrite, extent, update_user_config, service="prism"):
-    """Download the newest DEM data from the Copernicus Sentinel dataset.
+    """Download the newest DEM data from the Copernicus Sentinel dataset. [1]_
 
     Only the GLO-30 DEM, wich has a 30m resolution, is downloaded as it is freely available.
     If you register as a scientific researcher also the EEA-10, with 10 m resolution, is available.
@@ -136,8 +140,9 @@ def download_dem(out_dir, overwrite, extent, update_user_config, service="prism"
     After downloading the data, the files are merged and saved as a single tif file in the data directory in a subfolder called 'dems'.
     To use the DEM data in the WeatherDB, you will have to define the path to the tif file in the configuration file.
 
-    Source:
-    Copernicus DEM - Global and European Digital Elevation Model. Digital Surface Model (DSM) provided in 3 different resolutions (90m, 30m, 10m) with varying geographical extent (EEA: European and GLO: global) and varying format (INSPIRE, DGED, DTED). DOI:10.5270/ESA-c5d3d65.
+    References:
+    -----------
+    .. [1] Copernicus DEM - Global and European Digital Elevation Model. Digital Surface Model (DSM) provided in 3 different resolutions (90m, 30m, 10m) with varying geographical extent (EEA: European and GLO: global) and varying format (INSPIRE, DGED, DTED). `DOI:10.5270/ESA-c5d3d65 <https://doi.org/10.5270/ESA-c5d3d65>`_
     """
     click.echo("Starting downloading digital elevation model from Copernicus")
     from weatherdb.utils.get_data import download_dem
@@ -221,6 +226,16 @@ def set_db_version():
     else:
         click.echo("aborting setting db version")
 
+@cli.command(short_help="Forcefully set the active broker flag in the database to deactivated. This is useful if the broker got exited before it could deactivate itself. (!!!Only use this if you're sure that the database did all the necessary updates!!!)")
+def force_deactivate_all_broker():
+    click.echo(dedent("""
+        Are you sure that there is no more broker running? This could lead to problems as multiple brokers could run at the same time contradicting themself."""))
+    if click.confirm("Are you sure you want to set the activation flag in the database to deactivated?"):
+        click.echo("deactivating the brokers flag")
+        broker = weatherdb.broker.Broker()
+        broker.force_deactivate_all()
+    else:
+        click.echo("aborting the deactivation of the brokers flag")
 
 # cli
 # ---------------------------------------

{weatherdb-1.2.0 → weatherdb-1.2.1}/weatherdb/config/config_default.ini

@@ -143,6 +143,7 @@ RASTER_BUFFER_CRS = ${weatherdb:HORIZON_CRS}
 ; The default is 1999-01-01
 MIN_DATE = 1999-01-01
 
+[weatherdb:LINEAR_INTERPOLATION_LIMIT]
 ; When there are still NAs after filling with neighboring stations, the module can use linear interpolation to fill the gaps
 ; The limit defines the maximum interval that is allowed to fill with linear interpolation
 ; The value is given with a unit, e.g. 3 days, 30 minutes, 1 hour
@@ -150,11 +151,11 @@ MIN_DATE = 1999-01-01
 ; for precipitation, where the timeseries resolution is 10 minutes, 30 minutes means 3 missing values are interpolated, but not more.
 ; If there shouldn't be any linear interpolation, set the limit to 0
 ; For precipitation, the default is 1 hour
-LINEAR_INTERPOLATION_LIMIT_P = 1 hour
+P = 1 hour
 ; For temperature, the default is 2 days
-LINEAR_INTERPOLATION_LIMIT_T = 2 days
+T = 2 days
 ; For Evapotranspiration, the default is 2 days
-LINEAR_INTERPOLATION_LIMIT_ET = 2 days
+ET = 2 days
 
 
 [weatherdb:max_fillup_distance]
@@ -167,6 +168,21 @@ T = 150000
 ; Evapotranspiration (ET)
 ET = 150000
 
+
+[system:parallel_processes]
+; You can configure how many processes are getting started in parrallel when tghe database is updated.
+; depending on your system, the database can handle more or less processes
+; There  are 2 possible ways to configure this.
+; either define the absolute number of processes:
+; ABSOLUTE =
+
+; or define the number of processes in relation to the number of CPUs,
+; by defining how many CPUs should be used less than the maximum available CPUs
+; if the absolute number is defined, the relative number is ignored
+; This is the default setting of cpu count -1
+CPU_COUNT_MINUS = 1
+
+
 ; for developpers:
 ; ----------------
 ;

{weatherdb-1.2.0 → weatherdb-1.2.1}/weatherdb/station/StationBases.py

@@ -1493,8 +1493,8 @@ class StationBase:
 
         # linear interpolation for the last missing values
         lr_limit = config.get(
-            "weatherdb",
-            "LINEAR_INTERPOLATION_LIMIT_{self._para_base}",
+            "weatherdb:linear_interpolation_limit",
+            self._para_base,
             fallback="0")
         if lr_limit != "0":
             sql_format_dict.update(dict(
@@ -1507,8 +1507,9 @@ class StationBase:
                                 WITH empty_periods AS (
                                     SELECT *
                                     FROM (  SELECT
-                                                CASE WHEN dist_next>'{self._interval}'::interval
-                                                     THEN timestamp ELSE NULL
+                                                CASE WHEN dist_next::interval>'{self._interval}'::interval
+                                                     THEN timestamp
+                                                     ELSE NULL
                                                 END AS start,
                                                 CASE WHEN dist_next>'{self._interval}'::interval
                                                      THEN LEAD(timestamp) OVER (ORDER BY timestamp)
@@ -1516,8 +1517,12 @@ class StationBase:
                                                 END AS end
                                             FROM (
                                                 SELECT *,
-                                                    timestamp - lag(timestamp, 1) OVER ( ORDER BY timestamp) AS dist_prev,
-                                                    lead(timestamp, 1) OVER ( ORDER BY timestamp) - timestamp AS dist_next
+                                                    (timestamp::timestamp
+                                                        - lag(timestamp::timestamp, 1)  OVER ( ORDER BY timestamp)
+                                                    )::interval AS dist_prev,
+                                                    (lead(timestamp::timestamp, 1) OVER ( ORDER BY timestamp)
+                                                        - timestamp::timestamp
+                                                    )::interval AS dist_next
                                                 FROM new_filled_{self.id}_{self._para}
                                                 WHERE filled IS NOT NULL) t
                                             WHERE t.dist_prev > '{self._interval}'::interval
@@ -1529,18 +1534,20 @@ class StationBase:
                                     ttss.filled AS value_start,
                                     ep.end AS timestamp_end,
                                     ttse.filled AS value_end,
-                                    (ttse.filled - ttss.filled)::numeric/(EXTRACT(EPOCH FROM (ep.end - ep.start))/EXTRACT(EPOCH FROM '{self._interval}'::interval))::numeric as slope
+                                    (ttse.filled - ttss.filled)::numeric/(EXTRACT(EPOCH FROM (ep.end::timestamp - ep.start::timestamp))/EXTRACT(EPOCH FROM '{self._interval}'::interval))::numeric as slope
                                 FROM empty_periods ep
-                                LEFT JOIN new_filled_{self.id}_{self._para} ttss ON ep.start = ttss.timestamp
-                                LEFT JOIN new_filled_{self.id}_{self._para} ttse ON ep.end = ttse.timestamp
-                                where (ep.end - ep.start - '{self._interval}'::interval) <= '{lr_limit}'::interval
+                                LEFT JOIN new_filled_{self.id}_{self._para} ttss ON ep.start::timestamp = ttss.timestamp::timestamp
+                                LEFT JOIN new_filled_{self.id}_{self._para} ttse ON ep.end::timestamp = ttse.timestamp::timestamp
+                                WHERE (ep.end::timestamp - ep.start::timestamp - '{self._interval}'::interval) <= '{lr_limit}'::interval
                             loop
                                 execute FORMAT(
                                 $$
                                 UPDATE new_filled_{self.id}_{self._para} ts
-                                SET filled=%2$L + (EXTRACT(EPOCH FROM ts.timestamp - %1$L)::numeric/(EXTRACT(EPOCH FROM '{self._interval}'::interval))::numeric * %5$L),
-                                    filled_by=-1
-                                WHERE ts.timestamp>%1$L and ts.timestamp<%3$L;
+                                SET filled=%2$L::numeric + (%5$L::numeric *
+                                        EXTRACT(EPOCH FROM ts.timestamp::timestamp - %1$L::timestamp)::numeric
+                                         /EXTRACT(EPOCH FROM '{self._interval}'::interval)::numeric),
+                                    filled_by={"ARRAY[-1]::smallint[]" if self._filled_by_n>1 else "-1::smallint"}
+                                WHERE ts.timestamp > %1$L AND ts.timestamp < %3$L;
                                 $$,
                                 reg_borders.timestamp_start,
                                 reg_borders.value_start,
@@ -1880,8 +1887,8 @@ class StationBase:
             The timeseries kinds of the denominator or the multi annual raster key.
             If the denominator is a multi annual raster key, then the result is the quotient of the timeserie and the raster value.
             Possible values are:
-                - for timeserie kinds: 'raw', 'qc', 'filled' or for precipitation also "corr".
-                - for raster keys: 'hyras', 'dwd' or 'regnie', depending on your defined raster files.
+            - for timeserie kinds: 'raw', 'qc', 'filled' or for precipitation also "corr".
+            - for raster keys: 'hyras', 'dwd' or 'regnie', depending on your defined raster files.
         return_as : str, optional
             The format of the return value.
             If "df" then a pandas DataFrame is returned.
@@ -2219,7 +2226,6 @@ class StationBase:
             The elevation difference is considered with the formula from LARSIM (equation 3-18 & 3-19 from the LARSIM manual [1]_ ):
 
             .. math::
-
                 L_{weighted} = L_{horizontal} * (1 + (\\frac{|\\delta H|}{P_1})^{P_2})
             If None, then the height difference is not considered and only the nearest stations are returned.
             The default is None.
@@ -2916,18 +2922,21 @@ class StationTETBase(StationCanVirtualBase):
         Parameters
         ----------
         p_elev : tuple, optional
-            In Larsim those parameters are defined as $P_1 = 500$ and $P_2 = 1$.
-            Stoelzle et al. (2016) found that $P_1 = 100$ and $P_2 = 4$ is better for Baden-Würtemberg to consider the quick changes in topographie.
+            In Larsim [3]_ those parameters are defined as $P_1 = 500$ and $P_2 = 1$.
+            Stoelzle et al. (2016) [2]_ found that $P_1 = 100$ and $P_2 = 4$ is better for Baden-Würtemberg to consider the quick changes in topographie.
             For all of germany, those parameter values are giving too much weight to the elevation difference, which can result in getting neighboor stations from the border of the Tschec Republic for the Feldberg station. Therefor the values $P_1 = 250$ and $P_2 = 1.5$ are used as default values.
-            literature:
-                - Stoelzle, Michael & Weiler, Markus & Steinbrich, Andreas. (2016) Starkregengefährdung in Baden-Württemberg – von der Methodenentwicklung zur Starkregenkartierung. Tag der Hydrologie.
-                - LARSIM Dokumentation, Stand 06.04.2023, online unter https://www.larsim.info/dokumentation/LARSIM-Dokumentation.pdf
             The default is (250, 1.5).
 
+        References
+        ----------
+        .. [2] Stoelzle, Michael & Weiler, Markus & Steinbrich, Andreas. (2016) Starkregengefährdung in Baden-Württemberg – von der Methodenentwicklung zur Starkregenkartierung. Tag der Hydrologie.
+        .. [3] LARSIM Dokumentation, Stand 06.04.2023, online unter `LARSIM-Dokumentation <https://www.larsim.info/dokumentation/LARSIM-Dokumentation.pdf>`_
+
         Returns
         -------
-        _type_
-            _description_
+        list of int
+            A list of station Ids in order of distance.
+            The closest station is the first in the list.
         """
         # define the P1 and P2 default values for T and ET
         return super().get_neighboor_stids(p_elev=p_elev, **kwargs)

{weatherdb-1.2.0 → weatherdb-1.2.1}/weatherdb/stations/StationsBase.py

@@ -20,6 +20,7 @@ from ..utils.dwd import get_dwd_meta, get_cdc_file_list
 from ..station.StationBases import StationBase
 from ..db import models
 from ..db.queries.get_quotient import _get_quotient
+from ..config import config
 
 # set settings
 # ############
@@ -430,8 +431,8 @@ class StationsBase:
             The timeseries kinds of the denominator or the multi annual raster key.
             If the denominator is a multi annual raster key, then the result is the quotient of the timeserie and the raster value.
             Possible values are:
-                - for timeserie kinds: 'raw', 'qc', 'filled' or for precipitation also "corr".
-                - for raster keys: 'hyras', 'dwd' or 'regnie', depending on your defined raster files.
+            - for timeserie kinds: 'raw', 'qc', 'filled' or for precipitation also "corr".
+            - for raster keys: 'hyras', 'dwd' or 'regnie', depending on your defined raster files.
         stids : list of Integer
             The stations IDs for which to compute the quotient.
         return_as : str, optional
@@ -567,7 +568,16 @@ class StationsBase:
         return pbar
 
     def _run_method(self, stations, method, name, kwds=dict(),
-            do_mp=True, processes=mp.cpu_count()-1, **kwargs):
+            do_mp=True,
+            processes=config.getint(
+                "system:parallel_processes",
+                "absolute",
+                fallback=mp.cpu_count() - \
+                    config.getint(
+                        "system:parallel_processes",
+                        "cpu_count_minus",
+                        fallback=1)),
+            **kwargs):
         """Run methods of the given stations objects in multiprocessing/threading mode.
 
         Parameters
@@ -589,6 +599,9 @@ class StationsBase:
         processes : int, optional
             The number of processes that should get started simultaneously.
             If 1 or less, then the process is computed as a simple loop, so there is no multiprocessing or threading done.
+            There are two possible configuration values in the config file to set the number of processes:
+            - system:parallel_processes:absolute: The absolute number of processes to start.
+            - system:parallel_processes:cpu_count_minus: The number of CPU kernels are substracted by this number, to get the number of processes to start.
             The default is the cpu count -1.
         """
         log.info(

{weatherdb-1.2.0 → weatherdb-1.2.1}/weatherdb/utils/get_data.py

@@ -22,11 +22,11 @@ log = logging.getLogger(__name__)
 def download_ma_rasters(which="all", overwrite=None, update_user_config=False):
     """Get the multi annual rasters on which bases the regionalisation is done.
 
-    The refined multi annual datasets, that are downloaded are published on Zenodo [1]_
+    The refined multi annual datasets, that are downloaded are published on Zenodo. [1]_
 
     References
     ----------
-    .. [1] Schmit, M.; Weiler, M. (2023). German weather services (DWD) multi annual meteorological rasters for the climate period 1991-2020 refined to 25m grid (1.0.0) [Data set]. Zenodo. https://doi.org/10.5281/zenodo.10066045
+    .. [1] Schmit, M.; Weiler, M. (2023). German weather services (DWD) multi annual meteorological rasters for the climate period 1991-2020 refined to 25m grid (1.0.0) [Data set]. Zenodo. `DOI:10.5281/zenodo.10066045 <https://doi.org/10.5281/zenodo.10066045>`_
 
     Parameters
     ----------
@@ -360,14 +360,14 @@ def _download_dem_opentopo(
             log.info(f"Downloaded DEM data from OpenTopography to '{out_fp}'.")
             return out_fp
 
-    log.error(f"Request to openTopography API with url {r.url.replace(api_key, "[MASKED]")} returned status code {r.status_code}")
+    log.error(f"Request to openTopography API with url {r.url.replace(api_key, '[MASKED]')} returned status code {r.status_code}")
 
 def download_dem(out_dir=None,
                  overwrite=None,
                  extent=(5.3, 46.1, 15.6, 55.4),
                  update_user_config=False,
                  service=["prism", "openTopography"], **kwargs):
-    """Download the newest DEM data from the Copernicus Sentinel dataset.
+    """Download the newest DEM data from the Copernicus Sentinel dataset. [2]_
 
     Only the GLO-30 DEM, which has a 30m resolution, is downloaded as it is freely available.
     If you register as a scientific researcher also the EEA-10, with 10 m resolution, is available.
@@ -376,8 +376,9 @@ def download_dem(out_dir=None,
     After downloading the data, the files are merged and saved as a single tif file in the data directory in a subfolder called 'DEM'.
     To use the DEM data in the WeatherDB, you will have to define the path to the tif file in the configuration file.
 
-    Source:
-    Copernicus DEM - Global and European Digital Elevation Model. Digital Surface Model (DSM) provided in 3 different resolutions (90m, 30m, 10m) with varying geographical extent (EEA: European and GLO: global) and varying format (INSPIRE, DGED, DTED). DOI:10.5270/ESA-c5d3d65.
+    References
+    ----------
+    .. [2] Copernicus DEM - Global and European Digital Elevation Model. Digital Surface Model (DSM) provided in 3 different resolutions (90m, 30m, 10m) with varying geographical extent (EEA: European and GLO: global) and varying format (INSPIRE, DGED, DTED). `DOI:10.5270/ESA-c5d3d65 <https://doi.org/10.5270/ESA-c5d3d65>`_ .
 
     Parameters
     ----------

{weatherdb-1.2.0 → weatherdb-1.2.1}/weatherdb.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: weatherdb
-Version: 1.2.0
+Version: 1.2.1
 Summary: This is a package to work with and to create the Weather Database which handles, checks, fills and corrects DWD Weather Station data.
 Author-email: Max Schmit <max.schmit@hydrology.uni-freiburg.de>
 License:                     GNU GENERAL PUBLIC LICENSE

{weatherdb-1.2.0 → weatherdb-1.2.1}/weatherdb.egg-info/SOURCES.txt

@@ -26,11 +26,22 @@ docs/source/_static/favicon.ico
 docs/source/_static/logo.png
 docs/source/api/api.rst
 docs/source/api/cli.rst
-docs/source/api/weatherDB.broker.rst
+docs/source/api/weatherdb.broker.rst
 docs/source/api/weatherdb.config.rst
 docs/source/api/weatherdb.db.rst
 docs/source/api/weatherdb.rst
+docs/source/api/weatherdb.station.GroupStation.rst
+docs/source/api/weatherdb.station.StationBases.rst
+docs/source/api/weatherdb.station.StationET.rst
+docs/source/api/weatherdb.station.StationP.rst
+docs/source/api/weatherdb.station.StationPD.rst
+docs/source/api/weatherdb.station.StationT.rst
 docs/source/api/weatherdb.station.rst
+docs/source/api/weatherdb.stations.StationsBase.rst
+docs/source/api/weatherdb.stations.StationsET.rst
+docs/source/api/weatherdb.stations.StationsP.rst
+docs/source/api/weatherdb.stations.StationsPD.rst
+docs/source/api/weatherdb.stations.StationsT.rst
 docs/source/api/weatherdb.stations.rst
 docs/source/api/weatherdb.utils.rst
 docs/source/setup/Configuration.md

weatherdb-1.2.0/docs/source/api/weatherDB.broker.rst

@@ -1,10 +0,0 @@
-broker
-------
-.. module:: weatherdb.broker
-
-Broker
-^^^^^^
-.. autoclass:: weatherdb.broker.Broker
-
-  .. autoclasstoc::
-

weatherdb-1.2.0/docs/source/api/weatherdb.station.rst

@@ -1,56 +0,0 @@
-station
--------
-.. module:: weatherdb.station
-
-StationP
-^^^^^^^^
-.. autoclass:: weatherdb.station.StationP
-
-  .. autoclasstoc::
-
-StationT
-^^^^^^^^
-.. autoclass:: weatherdb.station.StationT
-
-  .. autoclasstoc::
-
-StationET
-^^^^^^^^^
-
-.. autoclass:: weatherdb.station.StationET
-
-  .. autoclasstoc::
-
-StationPD
-^^^^^^^^^
-.. autoclass:: weatherdb.station.StationPD
-   :exclude-members: quality_check, last_imp_quality_check, get_corr, get_adj, get_qc
-
-  .. autoclasstoc::
-
-GroupStation
-^^^^^^^^^^^^
-.. autoclass:: weatherdb.station.GroupStation
-
-   .. autoclasstoc::
-
-StationBase...
-^^^^^^^^^^^^^^
-Those are the base station classes on which the real station classes above depend on.
-None of them is working on its own, because the class variables are not yet set correctly.
-
-.. autoclass:: weatherdb.station.StationBases.StationBase
-
-  .. autoclasstoc::
-
-.. autoclass:: weatherdb.station.StationBases.StationPBase
-
-  .. autoclasstoc::
-
-.. autoclass:: weatherdb.station.StationBases.StationCanVirtualBase
-
-  .. autoclasstoc::
-
-.. autoclass:: weatherdb.station.StationBases.StationTETBase
-
-  .. autoclasstoc::

weatherdb-1.2.0/docs/source/api/weatherdb.stations.rst

@@ -1,46 +0,0 @@
-stations
---------
-.. module:: weatherdb.stations
-
-StationsP
-^^^^^^^^^
-.. autoclass:: weatherdb.stations.StationsP
-
-  .. autoclasstoc::
-
-StationsT
-^^^^^^^^^
-.. autoclass:: weatherdb.stations.StationsT
-
-  .. autoclasstoc::
-
-StationsET
-^^^^^^^^^^
-.. autoclass:: weatherdb.stations.StationsET
-
-  .. autoclasstoc::
-
-StationsPD
-^^^^^^^^^^
-.. autoclass:: weatherdb.stations.StationsPD
-
-  .. autoclasstoc::
-
-GroupStations
-^^^^^^^^^^^^^
-.. autoclass:: weatherdb.stations.GroupStations
-
-  .. autoclasstoc::
-
-StationsBase...
-^^^^^^^^^^^^^^^
-Those are the base stations classes on which the real stations classes above depend on.
-None of them is working on its own, because the class variables are not yet set correctly.
-
-.. autoclass:: weatherdb.stations.StationsBase.StationsBase
-
-  .. autoclasstoc::
-
-.. autoclass:: weatherdb.stations.StationsBaseTET.StationsBaseTET
-
-   .. autoclasstoc::

weatherdb-1.2.0/weatherdb/_version.py

@@ -1 +0,0 @@
-__version__ = "1.2.0"