Metadata-Version: 2.4
Name: rws-waterinfo
Version: 1.0.1
Summary: A Python wrapper for the Rijkswaterstaat WaterWebservices (ddapi20) API. Simplifies downloading observation data, forecasts, tidal extremes, chemical concentrations and more.
Home-page: https://gitlab.com/st14n/rws-waterinfo
Author: RWS | Stijn Schmitz
Author-email: stijn.schmitz@rws.nl
Keywords: Rijkswaterstaat waterinfo ddapi20 hydrology water
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
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: Programming Language :: Python :: 3.14
License-File: LICENSE
Requires-Dist: pandas
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: bandit; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: flake8-bugbear; extra == "dev"
Requires-Dist: flake8-comprehensions; extra == "dev"
Requires-Dist: flake8-docstrings; extra == "dev"
Requires-Dist: flake8-polyfill; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: mypy; 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: radon; extra == "dev"
Requires-Dist: rstcheck[sphinx]; extra == "dev"
Requires-Dist: safety; extra == "dev"
Requires-Dist: sh; extra == "dev"
Requires-Dist: types-requests; extra == "dev"
Provides-Extra: doc
Requires-Dist: pydata-sphinx-theme; extra == "doc"
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

################
rws waterinfo
################

.. begin-inclusion-intro-marker-do-not-remove



.. end-inclusion-intro-marker-do-not-remove


.. begin-inclusion-usage-marker-do-not-remove

How to use
----------

Provide user documentation here.

.. end-inclusion-usage-marker-do-not-remove


.. begin-inclusion-installation-marker-do-not-remove

Installation
------------

To install rws_waterinfo, do:

.. code-block:: console

  pip install rws-waterinfo


Run tests with:

.. code-block:: console

  pip install -r requirements-dev.txt
  pytest

.. end-inclusion-installation-marker-do-not-remove


Example
-------

Get observation data from Waterinfo using the ddapi20 API.

Location coordinates are no longer required; use the unified location codes
(for example ``ameland.nes`` or ``hoekvanholland``).

The primary change is the parameter format: the library now expects a list
of lists (7 items) instead of the older 9-item format with X/Y coordinates.

New format (each inner list):

- compartiment_code
- eenheid_code
- meetapparaat_code
- grootheid_code
- locatie_code
- start_date (YYYY-MM-DD)
- end_date (YYYY-MM-DD)

By default the client uses parallel downloads for better performance. Use
the ``max_workers`` argument to control concurrency.

.. code-block:: python

    import pandas as pd
    import rws_waterinfo as rw

    # Initialize rws_waterinfo library
    params = [
        ["OW", "", "", "WATHTE", "ameland.nes", "2025-12-01", "2026-01-01"]
    ]

    # Default is parallel download; specify max_workers if needed
    df = rw.get_data(params=params, return_df=True, max_workers=8)
    print(df.head())


This function sends a request to Waterinfo for parameter information
and parses the response into a Pandas DataFrame. The DataFrame contains
the locations and parameters combined into a single table.

.. code-block:: python

    import pandas as pd
    import rws_waterinfo as rw

    catalog = rw.get_catalog()
    print(catalog.head())


.. begin-inclusion-license-marker-do-not-remove

License
-------

Copyright (c) 2026, Rijkswaterstaat



.. end-inclusion-license-marker-do-not-remove


