From ac4a954c651892db27a882aad187a26c592f8ad1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mirko=20M=C3=A4licke?= Date: Mon, 29 Jan 2024 09:34:24 +0100 Subject: [PATCH] update readme --- RELEASE.md | 11 ++++++++++- examples/hyras/README.md | 11 +++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index 6cec1cd..1597a08 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,3 +1,12 @@ # V-FOR-WaTer data loader -This is a containerized Python tool to download data from [V-FOR-WaTer](https://portal.vforwater.de) following the [Tool Specification](https://vforwater.github.io/tool-specs/) for reusable research software using Docker. \ No newline at end of file +This is a containerized Python tool to download data from [V-FOR-WaTer](https://portal.vforwater.de) following the [Tool Specification](https://vforwater.github.io/tool-specs/) for reusable research software using Docker. + +## HYRAS example + +You can follow the instructions in [`examples/hyras`](https://github.com/VForWaTer/tool_vforwater_loader/tree/main/examples/hyras) +to spin up a local docker cluster using docker compose, that will +1. install PostgreSQL / PostGIS, +2. create the necessary tables and pre-poluates them +3. downloads 10 years of HYRAS precipitation data +4. use one of three prepared hyrdo-MERIT catchments to clip the hyras data to the respective catchment \ No newline at end of file diff --git a/examples/hyras/README.md b/examples/hyras/README.md index 445336b..447002f 100644 --- a/examples/hyras/README.md +++ b/examples/hyras/README.md @@ -17,4 +17,15 @@ db is not there. Then, invoke the installer manually, until that issue is resolv ``` docker compose -f examples/hyras/docker-compose.yml run --rm installer +``` + +The same thing applies to the actual examples. I can't figure out a way, how they could `depend_on: installer`, +in a way, that they wait until the installer has *finished*. +Hence, their default command is overwritten to just echo the command that one would need to actually run the tool. + +Long story short: To run one of the examples, with the `/examples/hyras` compose cluster running, you can: + +``` +cd examples/hyras +docker compose run --rm de410890 python run.py ``` \ No newline at end of file