rook

Versions

Python Package Index Build Conda-forge Build Version Supported Python Versions

Documentation and Support

Documentation Status Bird-house Gitter Chat

Open Source Coding Standards

License Ruff prek pre-commit.ci status

Development Status

Project Status: Active - The project has reached a stable, usable state and is being actively developed. Build Status
rook (the bird)

An intelligent and social bird that surveys vast landscapes, finds what matters, and brings it within easy reach.

rook

Remote Operations On Klimadaten.

Rook: Smart access to climate data.

Like the bird, Rook surveys vast climate archives, finds what matters, and brings it within easy reach.

Rook is a service of the roocs project that provides remote operations for large climate datasets.

The processing operations are implemented in Python on top of xarray and the clisops library, enabling efficient subsetting, averaging, and extraction of climate data from archives such as CMIP and CORDEX.

Rook in a Minute

Get a local service running with the minimal setup:

$ git clone https://github.com/roocs/rook.git
$ cd rook
$ conda env create -f environment.yml
$ conda activate rook
$ make develop
$ make start

Then test the service endpoint in your browser:

http://localhost:5000/wps?service=WPS&version=1.0.0&request=GetCapabilities

Use make stop to stop the local service.

Health Check

Rook provides a lightweight synchronous WPS process for health monitoring:

/wps?service=WPS&version=1.0.0&request=Execute&identifier=health&RawDataOutput=status

A healthy response is plain text containing exactly ROOK_HEALTH_OK. Failed checks omit that marker and return an OGC exception with a concise explanation. Monitoring should therefore require an exact match of the success marker.

Optional filesystem checks select projects configured in roocs.ini:

[health]
projects = c3s-cordex, c3s-cmip6, c3s-cica-atlas

For each selected project, the health process takes its existing base_dir and opens base_dir/.health-check.txt to read one byte. For example, c3s-cordex checks the sentinel below [project:c3s-cordex]. This tests actual read access to mounts such as Lustre without duplicating paths, loading a dataset, or searching large directory trees. All selected projects must be readable. Public failure messages use project names but do not expose filesystem paths. With no projects configured, the process only checks that Rook can execute it.

Documentation

Learn more about Rook in its official documentation at https://rook-wps.readthedocs.io.

Submit bug reports, questions, and feature requests at https://github.com/roocs/rook/issues

Contributing

You can find information about contributing in our Developer Guide.

Use bump-my-version to release a new version.

Patch Release Quickstart

Minimal patch release flow (example: 1.2.1):

$ edit CHANGELOG.rst
$ make conda-spec
$ bump-my-version bump --new-version 1.2.1 patch
$ git push
$ git push --tags

What this does:

  • edit CHANGELOG.rst adds the release notes for the new patch version.

  • make conda-spec regenerates conda-lock.yml and linux-64.spec (and refreshes spec-file.txt).

  • bump-my-version updates version metadata and creates the release tag.

  • git push publishes the commit.

  • git push --tags publishes the release tag and triggers release/tag workflows.

Tests

The tests folder includes additional tests for deployed Rook services.

  • Smoke test: ensure the service is operational. See tests/smoke/README.md.

  • Storm test: load-test using locust. See tests/storm/README.md.

License

Credits

This package was created with Cookiecutter and the bird-house/cookiecutter-birdhouse project template.

Table of Contents

GitHub Repository

Indices and tables