rainfallqc 0.2.4__tar.gz → 0.3.0__tar.gz

rainfallqc-0.3.0/PKG-INFO

@@ -0,0 +1,333 @@
+Metadata-Version: 2.4
+Name: rainfallqc
+Version: 0.3.0
+Summary: Quality control for rainfall data
+Author-email: Tom Keel <tomkee@ceh.ac.uk>
+Maintainer-email: Tom Keel <tomkee@ceh.ac.uk>
+Requires-Python: >=3.10.0
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Scientific/Engineering :: Hydrology
+License-File: LICENSE
+Requires-Dist: scipy
+Requires-Dist: numpy
+Requires-Dist: polars>=1.30
+Requires-Dist: pandas
+Requires-Dist: pyarrow
+Requires-Dist: xarray
+Requires-Dist: netCDF4
+Requires-Dist: bottleneck
+Requires-Dist: geopy
+Requires-Dist: poligrain
+Requires-Dist: pypwsqc
+Requires-Dist: pip ; extra == "dev"
+Requires-Dist: numpy ; extra == "dev"
+Requires-Dist: bump-my-version ; extra == "dev"
+Requires-Dist: ruff ; extra == "dev"
+Requires-Dist: black ; extra == "dev"
+Requires-Dist: pre_commit ; extra == "dev"
+Requires-Dist: pylint ; extra == "dev"
+Requires-Dist: pytest ; extra == "dev"
+Requires-Dist: pytest-cov ; extra == "dev"
+Requires-Dist: matplotlib ; extra == "dev"
+Requires-Dist: sphinx ; extra == "dev"
+Requires-Dist: sphinx ; extra == "docs"
+Requires-Dist: sphinx-copybutton ; extra == "docs"
+Requires-Dist: sphinx-rtd-theme ; extra == "docs"
+Requires-Dist: mypy ; extra == "lint"
+Requires-Dist: ruff ; extra == "lint"
+Requires-Dist: pytest ; extra == "test"
+Requires-Dist: pytest-cov ; extra == "test"
+Project-URL: bugs, https://github.com/thomasjkeel/RainfallQC/issues
+Project-URL: changelog, https://github.com/thomasjkeel/RainfallQC/blob/master/changelog.md
+Project-URL: homepage, https://github.com/thomasjkeel/RainfallQC
+Provides-Extra: dev
+Provides-Extra: docs
+Provides-Extra: lint
+Provides-Extra: test
+
+.. image:: https://github.com/NERC-CEH/RainfallQC/blob/main/docs/logos/rainfallQC_logo.png
+   :align: center
+   :height: 180px
+   :width: 200 px
+   :alt: RainfallQC
+
+===============================================
+RainfallQC - Quality control for rainfall data
+===============================================
+
+.. image:: https://img.shields.io/pypi/v/rainfallqc.svg
+        :target: https://pypi.python.org/pypi/rainfallqc
+
+..
+    image:: https://readthedocs.org/projects/rainfallqc/badge/?version=latest
+        :target: https://rainfallqc.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+
+Provides methods for running rainfall quality control.
+
+Installation
+============
+RainfallQC can be installed from PyPi:
+
+.. code-block:: bash
+
+    pip install rainfallqc
+
+
+Example use
+===========
+
+Example 1. - Running individual checks on a single rain gauge
+-------------------------------------------------------------
+Let's say you have data for a single rain gauge stored in "hourly_rain_gauge_data.csv" which looks like this:
+
+.. table:: Example data 1. Single rain gauge
+    :widths: auto
+    :align: center
+
+    +---------------------+---------+
+    | time                | rain_mm |
+    +=====================+=========+
+    | 2020-01-01 00:00    | 0.0     |
+    +---------------------+---------+
+    | 2020-01-01 01:00    | 0.1     |
+    +---------------------+---------+
+    | 2020-01-01 02:00    | 0.0     |
+    +---------------------+---------+
+    | 2020-01-01 03:00    | 105.0   |
+    +---------------------+---------+
+    | 2020-01-01 04:00    | 0.6     |
+    +---------------------+---------+
+    | ...                 | ...     |
+    +---------------------+---------+
+
+
+For the majority of the checks in RainfallQC, you can load in your data using `polars <https://pola-rs.github.io/polars-book/>`_ and run the checks directly.
+Below, we run 2 example QC checks:
+
+- 1) ``check_intermittency`` - to flag years where there are periods of non-zero bounded by 0 (see Figure 1.),
+- 2) ``daily_accumulations`` - to flag accumulations of hourly values into daily.
+
+.. figure:: https://thomasjkeel.github.io/UK-Rain-Gauge-Network/example_images/intermittency.png
+   :align: center
+   :height: 250px
+   :width: 300px
+
+   **Figure 1.** Example of an intermittency issue within the rainfall record
+
+.. code-block:: python
+
+        import polars as pl
+        from rainfallqc import gauge_checks, timeseries_checks
+
+        data = pl.read_csv("hourly_rain_gauge_data.csv")
+
+        intermittent_years = gauge_checks.check_intermittency(data, target_gauge_col="rain_mm")
+
+        daily_accumulation_flags = timeseries_checks.check_daily_accumulations(
+            data,
+            target_gauge_col="rain_mm",
+            gauge_lat=52.0,
+            gauge_lon=2.0,
+            smallest_measurable_rainfall_amount=0.1,
+        )
+
+
+Please note that some checks may require additional metadata, such as gauge location (latitude and longitude) or smallest measurable rainfall amount (e.g. 0.1 mm).
+This could look like:
+
+.. table:: Example metadata 1. Rain gauge metadata
+    :widths: auto
+    :align: center
+
+    +--------------------+----------+-----------+------------------+------------------+---------------------+
+    | station_id         | latitude | longitude | start_datetime   | end_datetime     | path                |
+    +====================+==========+===========+==================+==================+=====================+
+    | rain_mm_gauge_1    | 53.0     | 2.0       | 2020-01-01 00:00 | 2024-01-01 00:00 | path/to/gauge_1.csv |
+    +--------------------+----------+-----------+------------------+------------------+---------------------+
+    | rain_mm_gauge_2    | 54.1     | -0.5      | 2018-01-01 00:00 | 2023-01-01 00:00 | path/to/gauge_2.csv |
+    +--------------------+----------+-----------+------------------+------------------+---------------------+
+    | rain_mm_gauge_3    | 56.9     | 1.9       | 2015-01-01 00:00 | 2025-01-01 00:00 | path/to/gauge_3.csv |
+    +--------------------+----------+-----------+------------------+------------------+---------------------+
+    | ...                | ...      | ...       |                  |                  | ...                 |
+    +--------------------+----------+-----------+------------------+------------------+---------------------+
+
+You could then run checks that require metadata i.e. the ``check_hourly_exceedance_etccdi_rx1day`` QC check which flags rainfall values exceeding
+the hourly day rainfall 1-day record at a given location (see Figure 2):
+
+.. figure:: https://thomasjkeel.github.io/UK-Rain-Gauge-Network/example_images/rx1day_check.png
+   :align: center
+   :height: 250px
+   :width: 300px
+
+   **Figure 2.** Example of an Rx1day check from the IntenseQC framework
+
+The code for that check looks like:
+
+.. code-block:: python
+
+        import polars as pl
+        from rainfallqc import comparison_checks
+
+        data = pl.read_csv("hourly_rain_gauge_data_gauge_1.csv")
+        metadata = pl.read_csv("rain_gauge_metadata.csv")
+
+        target_gauge_id = "rain_mm_gauge_1"
+        target_metadata = metadata.filter(pl.col("station_id") == target_gauge_id)
+
+        rx1day_check = comparison_checks.check_hourly_exceedance_etccdi_rx1day(
+             data,
+             target_gauge_col=target_gauge_col,
+             gauge_lat=target_metadata["latitude"],
+             gauge_lon=target_metadata["longitude"]
+        )
+
+Output flags will then look like:
+
+.. table:: Example flag outputs for the Rx1day QC check
+    :widths: auto
+    :align: center
+
+    +---------------------+--------------+
+    | time                | rx1day_check |
+    +=====================+==============+
+    | 2020-01-01 00:00    | 0            |
+    +---------------------+--------------+
+    | 2020-01-01 01:00    | 0            |
+    +---------------------+--------------+
+    | 2020-01-01 02:00    | 0            |
+    +---------------------+--------------+
+    | 2020-01-01 03:00    | 1            |
+    +---------------------+--------------+
+    | 2020-01-01 04:00    | 0            |
+    +---------------------+--------------+
+    | ...                 | ...          |
+    +---------------------+--------------+
+
+Example 2. - Running multiple QC checks on a single target gauge
+----------------------------------------------------------------
+To run multiple QC checks, you can use the `apply_qc_framework() <rainfallqc.checks.html#rainfallqc.qc_frameworks.html#module-rainfallqc.qc_frameworks.apply_qc_framework>`_
+method to run QC methods from a given framework (e.g. IntenseQC).
+
+Let's say you have hourly rainfall values from a rain gauge network data like:
+
+.. table:: Example data 2. Rain gauge network
+    :widths: auto
+    :align: center
+
+    +---------------------+-----------------+-----------------+-----------------+
+    | time                | rain_mm_gauge_1 | rain_mm_gauge_2 | rain_mm_gauge_3 |
+    +=====================+=================+=================+=================+
+    | 2020-01-01 00:00    | 0.0             | 0.5             | 0.0             |
+    +---------------------+-----------------+-----------------+-----------------+
+    | 2020-01-01 01:00    | 0.5             | 0.0             | 1.0             |
+    +---------------------+-----------------+-----------------+-----------------+
+    | 2020-01-01 02:00    | 0.0             | 1.0             | 0.0             |
+    +---------------------+-----------------+-----------------+-----------------+
+    | 2020-01-01 03:00    | 105.0           | 0.0             | 0.5             |
+    +---------------------+-----------------+-----------------+-----------------+
+    | 2020-01-01 04:00    | 0.0             | 0.5             | 0.0             |
+    +---------------------+-----------------+-----------------+-----------------+
+    | ...                 | ...             | ...             | ...             |
+    +---------------------+-----------------+-----------------+-----------------+
+
+
+... and metadata like example metdata 1.
+You can then run multiple QC checks at once by defining a QC framework, the methods to run and parameters for those methods.
+
+As of RainfallQC v0.3.0, there are three QC frameworks:
+
+1. "intenseqc" - All 25 checks from IntenseQC/GSDR-QC with names like: "QC1", "QC2" ... "QC25",
+2. "pypwsqc" - 2 checks from pyPWSQC with the names: "FZ" and "SO",
+3. "custom" - Allows the user to select a custom set of checks (see Example 8 in `Tutorials <https://rainfallqc.readthedocs.io/en/latest/tutorials.html>`_).
+
+Let's run some QC checks from intenseqc framework below:
+
+.. code-block:: python
+
+        import polars as pl
+        from rainfallqc.qc_frameworks import apply_qc_framework
+
+        network_data = pl.read_csv("hourly_rain_gauge_network.csv")
+        metadata = pl.read_csv("rain_gauge_metadata.csv")
+
+        # 1. Decide which QC methods of IntenseQC will be run
+        qc_framework = "IntenseQC"
+        qc_methods_to_run = ["QC1", "QC8", "QC9", "QC10", "QC11", "QC12", "QC14", "QC15", "QC16"]
+
+        # 2. Determine nearest neighbouring gauges for neighbourhood checks
+        gauge_lat = gpcc_metadata["latitude"]
+        gauge_lon = gpcc_metadata["longitude"]
+        nearest_neighbourhours = ["rain_mm_gauge_2", "rain_mm_gauge_3", ...] # or see Example 3 if not determined
+
+        # 2 Decide which parameters for QC
+        qc_kwargs = {
+            "QC1": {"quantile": 5},
+            "QC14": {"wet_day_threshold": 1.0, "accumulation_multiplying_factor": 2.0},
+            "QC16": {
+                "list_of_nearest_stations": nearest_neighbourhours,
+                "wet_threshold": 1.0,
+                "min_n_neighbours": 5,
+                "n_neighbours_ignored": 0,
+            },
+            "shared": {
+                "target_gauge_col": "rain_mm_gauge_1",
+                "gauge_lat": gauge_lat,
+                "gauge_lon": gauge_lon,
+                "time_res": "daily",
+                "smallest_measurable_rainfall_amount": 0.1,
+            },
+        }
+
+        # 3. Run QC methods on network data
+        qc_result = apply_qc_framework.run_qc_framework(
+            daily_rain_gauge_network, qc_framework=qc_framework, qc_methods_to_run=qc_methods_to_run, qc_kwargs=qc_kwargs
+        )
+
+Because lots of the checks share the same parameters with a standard vocabulary, you can use the "shared" part of the ``qc_kwargs`` dictionary to set those.
+
+Other examples
+--------------
+Of course, your data may not be tabular, or may not be stored in a single file. Therefore, please see our other `Tutorials <https://rainfallqc.readthedocs.io/en/latest/tutorials.html>`_.
+
+There is also a `demo notebook <https://github.com/Thomasjkeel/RainfallQC-notebooks/blob/main/notebooks/demo/rainfallQC_demo.ipynb>`_.
+
+Finally, different QC methods are suitable for different temporal resolutions, see our `Which checks are suitable for my data's temporal resolution? <https://rainfallqc.readthedocs.io/en/latest/quickstart.html>`_ for more information.
+
+Documentation and License
+=========================
+* RainfallQC is developed and maintained by UKCEH.
+* Free software: GNU General Public License v3
+* Documentation: https://rainfallqc.readthedocs.io.
+
+
+Features
+========
+
+- 27 rainfall QC methods (25 from IntenseQC, 2 from pyPWSQC)
+- polars DataFrame support for fast data processing
+- modular structure so you can pick and choose which checks to run
+- support for single gauges or networks of gauges
+- editable parameters so you can tweak thresholds, streak or accumulation lengths, and distances to neighbouring gauges
+
+Credits
+=======
+* Builds upon `IntenseQC <https://github.com/nclwater/intense-qc/tree/master>`_, and (is compatible with) `pyPWSQC <https://github.com/OpenSenseAction/pypwsqc>`_:
+* Please email tomkee@ceh.ac.uk if you have any questions.
+* This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
+

rainfallqc-0.3.0/README.rst

@@ -0,0 +1,274 @@
+.. image:: https://github.com/NERC-CEH/RainfallQC/blob/main/docs/logos/rainfallQC_logo.png
+   :align: center
+   :height: 180px
+   :width: 200 px
+   :alt: RainfallQC
+
+===============================================
+RainfallQC - Quality control for rainfall data
+===============================================
+
+.. image:: https://img.shields.io/pypi/v/rainfallqc.svg
+        :target: https://pypi.python.org/pypi/rainfallqc
+
+..
+    image:: https://readthedocs.org/projects/rainfallqc/badge/?version=latest
+        :target: https://rainfallqc.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+
+Provides methods for running rainfall quality control.
+
+Installation
+============
+RainfallQC can be installed from PyPi:
+
+.. code-block:: bash
+
+    pip install rainfallqc
+
+
+Example use
+===========
+
+Example 1. - Running individual checks on a single rain gauge
+-------------------------------------------------------------
+Let's say you have data for a single rain gauge stored in "hourly_rain_gauge_data.csv" which looks like this:
+
+.. table:: Example data 1. Single rain gauge
+    :widths: auto
+    :align: center
+
+    +---------------------+---------+
+    | time                | rain_mm |
+    +=====================+=========+
+    | 2020-01-01 00:00    | 0.0     |
+    +---------------------+---------+
+    | 2020-01-01 01:00    | 0.1     |
+    +---------------------+---------+
+    | 2020-01-01 02:00    | 0.0     |
+    +---------------------+---------+
+    | 2020-01-01 03:00    | 105.0   |
+    +---------------------+---------+
+    | 2020-01-01 04:00    | 0.6     |
+    +---------------------+---------+
+    | ...                 | ...     |
+    +---------------------+---------+
+
+
+For the majority of the checks in RainfallQC, you can load in your data using `polars <https://pola-rs.github.io/polars-book/>`_ and run the checks directly.
+Below, we run 2 example QC checks:
+
+- 1) ``check_intermittency`` - to flag years where there are periods of non-zero bounded by 0 (see Figure 1.),
+- 2) ``daily_accumulations`` - to flag accumulations of hourly values into daily.
+
+.. figure:: https://thomasjkeel.github.io/UK-Rain-Gauge-Network/example_images/intermittency.png
+   :align: center
+   :height: 250px
+   :width: 300px
+
+   **Figure 1.** Example of an intermittency issue within the rainfall record
+
+.. code-block:: python
+
+        import polars as pl
+        from rainfallqc import gauge_checks, timeseries_checks
+
+        data = pl.read_csv("hourly_rain_gauge_data.csv")
+
+        intermittent_years = gauge_checks.check_intermittency(data, target_gauge_col="rain_mm")
+
+        daily_accumulation_flags = timeseries_checks.check_daily_accumulations(
+            data,
+            target_gauge_col="rain_mm",
+            gauge_lat=52.0,
+            gauge_lon=2.0,
+            smallest_measurable_rainfall_amount=0.1,
+        )
+
+
+Please note that some checks may require additional metadata, such as gauge location (latitude and longitude) or smallest measurable rainfall amount (e.g. 0.1 mm).
+This could look like:
+
+.. table:: Example metadata 1. Rain gauge metadata
+    :widths: auto
+    :align: center
+
+    +--------------------+----------+-----------+------------------+------------------+---------------------+
+    | station_id         | latitude | longitude | start_datetime   | end_datetime     | path                |
+    +====================+==========+===========+==================+==================+=====================+
+    | rain_mm_gauge_1    | 53.0     | 2.0       | 2020-01-01 00:00 | 2024-01-01 00:00 | path/to/gauge_1.csv |
+    +--------------------+----------+-----------+------------------+------------------+---------------------+
+    | rain_mm_gauge_2    | 54.1     | -0.5      | 2018-01-01 00:00 | 2023-01-01 00:00 | path/to/gauge_2.csv |
+    +--------------------+----------+-----------+------------------+------------------+---------------------+
+    | rain_mm_gauge_3    | 56.9     | 1.9       | 2015-01-01 00:00 | 2025-01-01 00:00 | path/to/gauge_3.csv |
+    +--------------------+----------+-----------+------------------+------------------+---------------------+
+    | ...                | ...      | ...       |                  |                  | ...                 |
+    +--------------------+----------+-----------+------------------+------------------+---------------------+
+
+You could then run checks that require metadata i.e. the ``check_hourly_exceedance_etccdi_rx1day`` QC check which flags rainfall values exceeding
+the hourly day rainfall 1-day record at a given location (see Figure 2):
+
+.. figure:: https://thomasjkeel.github.io/UK-Rain-Gauge-Network/example_images/rx1day_check.png
+   :align: center
+   :height: 250px
+   :width: 300px
+
+   **Figure 2.** Example of an Rx1day check from the IntenseQC framework
+
+The code for that check looks like:
+
+.. code-block:: python
+
+        import polars as pl
+        from rainfallqc import comparison_checks
+
+        data = pl.read_csv("hourly_rain_gauge_data_gauge_1.csv")
+        metadata = pl.read_csv("rain_gauge_metadata.csv")
+
+        target_gauge_id = "rain_mm_gauge_1"
+        target_metadata = metadata.filter(pl.col("station_id") == target_gauge_id)
+
+        rx1day_check = comparison_checks.check_hourly_exceedance_etccdi_rx1day(
+             data,
+             target_gauge_col=target_gauge_col,
+             gauge_lat=target_metadata["latitude"],
+             gauge_lon=target_metadata["longitude"]
+        )
+
+Output flags will then look like:
+
+.. table:: Example flag outputs for the Rx1day QC check
+    :widths: auto
+    :align: center
+
+    +---------------------+--------------+
+    | time                | rx1day_check |
+    +=====================+==============+
+    | 2020-01-01 00:00    | 0            |
+    +---------------------+--------------+
+    | 2020-01-01 01:00    | 0            |
+    +---------------------+--------------+
+    | 2020-01-01 02:00    | 0            |
+    +---------------------+--------------+
+    | 2020-01-01 03:00    | 1            |
+    +---------------------+--------------+
+    | 2020-01-01 04:00    | 0            |
+    +---------------------+--------------+
+    | ...                 | ...          |
+    +---------------------+--------------+
+
+Example 2. - Running multiple QC checks on a single target gauge
+----------------------------------------------------------------
+To run multiple QC checks, you can use the `apply_qc_framework() <rainfallqc.checks.html#rainfallqc.qc_frameworks.html#module-rainfallqc.qc_frameworks.apply_qc_framework>`_
+method to run QC methods from a given framework (e.g. IntenseQC).
+
+Let's say you have hourly rainfall values from a rain gauge network data like:
+
+.. table:: Example data 2. Rain gauge network
+    :widths: auto
+    :align: center
+
+    +---------------------+-----------------+-----------------+-----------------+
+    | time                | rain_mm_gauge_1 | rain_mm_gauge_2 | rain_mm_gauge_3 |
+    +=====================+=================+=================+=================+
+    | 2020-01-01 00:00    | 0.0             | 0.5             | 0.0             |
+    +---------------------+-----------------+-----------------+-----------------+
+    | 2020-01-01 01:00    | 0.5             | 0.0             | 1.0             |
+    +---------------------+-----------------+-----------------+-----------------+
+    | 2020-01-01 02:00    | 0.0             | 1.0             | 0.0             |
+    +---------------------+-----------------+-----------------+-----------------+
+    | 2020-01-01 03:00    | 105.0           | 0.0             | 0.5             |
+    +---------------------+-----------------+-----------------+-----------------+
+    | 2020-01-01 04:00    | 0.0             | 0.5             | 0.0             |
+    +---------------------+-----------------+-----------------+-----------------+
+    | ...                 | ...             | ...             | ...             |
+    +---------------------+-----------------+-----------------+-----------------+
+
+
+... and metadata like example metdata 1.
+You can then run multiple QC checks at once by defining a QC framework, the methods to run and parameters for those methods.
+
+As of RainfallQC v0.3.0, there are three QC frameworks:
+
+1. "intenseqc" - All 25 checks from IntenseQC/GSDR-QC with names like: "QC1", "QC2" ... "QC25",
+2. "pypwsqc" - 2 checks from pyPWSQC with the names: "FZ" and "SO",
+3. "custom" - Allows the user to select a custom set of checks (see Example 8 in `Tutorials <https://rainfallqc.readthedocs.io/en/latest/tutorials.html>`_).
+
+Let's run some QC checks from intenseqc framework below:
+
+.. code-block:: python
+
+        import polars as pl
+        from rainfallqc.qc_frameworks import apply_qc_framework
+
+        network_data = pl.read_csv("hourly_rain_gauge_network.csv")
+        metadata = pl.read_csv("rain_gauge_metadata.csv")
+
+        # 1. Decide which QC methods of IntenseQC will be run
+        qc_framework = "IntenseQC"
+        qc_methods_to_run = ["QC1", "QC8", "QC9", "QC10", "QC11", "QC12", "QC14", "QC15", "QC16"]
+
+        # 2. Determine nearest neighbouring gauges for neighbourhood checks
+        gauge_lat = gpcc_metadata["latitude"]
+        gauge_lon = gpcc_metadata["longitude"]
+        nearest_neighbourhours = ["rain_mm_gauge_2", "rain_mm_gauge_3", ...] # or see Example 3 if not determined
+
+        # 2 Decide which parameters for QC
+        qc_kwargs = {
+            "QC1": {"quantile": 5},
+            "QC14": {"wet_day_threshold": 1.0, "accumulation_multiplying_factor": 2.0},
+            "QC16": {
+                "list_of_nearest_stations": nearest_neighbourhours,
+                "wet_threshold": 1.0,
+                "min_n_neighbours": 5,
+                "n_neighbours_ignored": 0,
+            },
+            "shared": {
+                "target_gauge_col": "rain_mm_gauge_1",
+                "gauge_lat": gauge_lat,
+                "gauge_lon": gauge_lon,
+                "time_res": "daily",
+                "smallest_measurable_rainfall_amount": 0.1,
+            },
+        }
+
+        # 3. Run QC methods on network data
+        qc_result = apply_qc_framework.run_qc_framework(
+            daily_rain_gauge_network, qc_framework=qc_framework, qc_methods_to_run=qc_methods_to_run, qc_kwargs=qc_kwargs
+        )
+
+Because lots of the checks share the same parameters with a standard vocabulary, you can use the "shared" part of the ``qc_kwargs`` dictionary to set those.
+
+Other examples
+--------------
+Of course, your data may not be tabular, or may not be stored in a single file. Therefore, please see our other `Tutorials <https://rainfallqc.readthedocs.io/en/latest/tutorials.html>`_.
+
+There is also a `demo notebook <https://github.com/Thomasjkeel/RainfallQC-notebooks/blob/main/notebooks/demo/rainfallQC_demo.ipynb>`_.
+
+Finally, different QC methods are suitable for different temporal resolutions, see our `Which checks are suitable for my data's temporal resolution? <https://rainfallqc.readthedocs.io/en/latest/quickstart.html>`_ for more information.
+
+Documentation and License
+=========================
+* RainfallQC is developed and maintained by UKCEH.
+* Free software: GNU General Public License v3
+* Documentation: https://rainfallqc.readthedocs.io.
+
+
+Features
+========
+
+- 27 rainfall QC methods (25 from IntenseQC, 2 from pyPWSQC)
+- polars DataFrame support for fast data processing
+- modular structure so you can pick and choose which checks to run
+- support for single gauges or networks of gauges
+- editable parameters so you can tweak thresholds, streak or accumulation lengths, and distances to neighbouring gauges
+
+Credits
+=======
+* Builds upon `IntenseQC <https://github.com/nclwater/intense-qc/tree/master>`_, and (is compatible with) `pyPWSQC <https://github.com/OpenSenseAction/pypwsqc>`_:
+* Please email tomkee@ceh.ac.uk if you have any questions.
+* This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

{rainfallqc-0.2.4 → rainfallqc-0.3.0}/pyproject.toml

@@ -68,7 +68,7 @@ homepage = "https://github.com/thomasjkeel/RainfallQC"
 target-version = ["py310", "py311", "py312", "py313"]
 
 [tool.bumpversion]
-current_version = "0.2.4"
+current_version = "0.3.0"
 commit = true
 message = "Bump version: {current_version} → {new_version}"
 commit_args = ""

{rainfallqc-0.2.4 → rainfallqc-0.3.0}/src/rainfallqc/__init__.py

@@ -2,7 +2,7 @@
 
 __author__ = """Tom Keel"""
 __email__ = "tomkee@ceh.ac.uk"
-__version__ = "0.2.4"
+__version__ = "0.3.0"
 
 from rainfallqc import core, utils
 from rainfallqc.checks import (