Skip to main content

A Python wrapper for the Rijkswaterstaat WaterWebservices (ddapi20) API. Simplifies downloading observation data, forecasts, tidal extremes, chemical concentrations and more.

Project description

How to use

Provide user documentation here.

Installation

To install rws_waterinfo, do:

pip install rws-waterinfo

Run tests with:

pip install -r requirements-dev.txt
pytest

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.

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.

import pandas as pd
import rws_waterinfo as rw

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

License

Copyright (c) 2026, Rijkswaterstaat

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rws_waterinfo-1.0.1.tar.gz (19.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rws_waterinfo-1.0.1-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file rws_waterinfo-1.0.1.tar.gz.

File metadata

  • Download URL: rws_waterinfo-1.0.1.tar.gz
  • Upload date:
  • Size: 19.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for rws_waterinfo-1.0.1.tar.gz
Algorithm Hash digest
SHA256 052fc260a01f595c51e5637055edef7e30bb71e3b47e4f52e3a59fc09a1df68e
MD5 69bc911cf2288f30b58cc907761e35b2
BLAKE2b-256 b55fef3f32eb82f77143d3f8ba0318f26fd980965cdee43ffc5d64ff50d6b079

See more details on using hashes here.

File details

Details for the file rws_waterinfo-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: rws_waterinfo-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 14.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for rws_waterinfo-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 62f3a637cbaf95ed53cfa8bc851b6c0c855256fcd95e50453e4445efd8f1a08c
MD5 74a07a89a6742a4f8a0e92d84fd7e771
BLAKE2b-256 144ecdbc88fb5e32a9ecd2e069cb048519c82d708072216ecee5e12759df3b50

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page