Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mmaelicke committed Jan 29, 2024
1 parent 1251140 commit ac4a954
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
11 changes: 10 additions & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
@@ -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.
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
11 changes: 11 additions & 0 deletions examples/hyras/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit ac4a954

Please sign in to comment.