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: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. 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.

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.

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.

GitHub Repository

Indices and tables