Skip to content

Commit

Permalink
add example, improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nicokant committed Dec 27, 2024
1 parent 63e5e51 commit fcdede0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ There are several commands available and documented:
```bash
> task -a
task: Available tasks for this project:
* queue: Run a queue of tasks from a file
* db:manage:materialize: Creates a DuckDB database file importing all the parquet files
* dump:restore:all-from-config:
* dump:restore:all-from-config: Restores tables from a config dump
* dump:restore:all-from-data: Restores the table weather, radar, observarion, classification, track according to the defined partition
* dump:restore:classification: Restores the table classification with a year partition
* dump:restore:location-partitioned: Restores a pg_dump table into a parquet file partitioned by location name
Expand All @@ -25,7 +26,7 @@ task: Available tasks for this project:
* dump:restore:weather: Restores the table weather with a month partition
* dump:restore:year-partitioned: Restores a pg_dump table into a parquet file partitioned by year
* pg:export: Export a table to parquet
* pg:export:all-from-config:
* pg:export:all-from-config: Export tables from the config schema
* pg:export:all-from-data: Exports the table weather, radar, observarion, classification, track according to the defined partition
* pg:export:classification: Exports the table classification with a year partition
* pg:export:location-partitioned: Exports a postgres table into a parquet file partitioned by location name
Expand All @@ -37,5 +38,8 @@ task: Available tasks for this project:
* pg:export:weather: Exports the table weather with a month partition
* pg:export:year-partitioned: Exports a postgres table into a parquet file partitioned by year
* track:generate:track-points: Extract track points from track linestrings
* track:generate:track-points-hogl: Compute height over ground level of a track point parquet and saves them into a new parquet
* track:generate:track-points-hogl: Compute height over ground level of a track point parquet and saves them into a new parquet
```

### Queue
The `queue` command allows to enqueue tasks in file, refer to `tasks.example` for an usage example, all the tasks will be run using `GNU parallel`.
3 changes: 3 additions & 0 deletions tasks.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
dump:restore:all-from-config RADAR_NAME=radar LOCATION_NAME=oslo MONTH=01 YEAR=2024 INPUT=example_config_dump.backup
dump:restore:all-from-data RADAR_NAME=radar LOCATION_NAME=oslo MONTH=01 YEAR=2024 INPUT=example_data_dump.backup
track:generate:track-points-hogl RADAR_NAME=radar LOCATION_NAME=oslo MONTH=01 YEAR=2024 ELEVATION_MODEL_PATH=dsm.tif

0 comments on commit fcdede0

Please sign in to comment.