Skip to content

Commit

Permalink
Add a section on results and logging config. Fixes #950
Browse files Browse the repository at this point in the history
  • Loading branch information
Huite committed Jan 16, 2024
1 parent 5723bdf commit 4522f44
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/core/usage.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,25 @@ Currently there are the following allocation settings:
- `use_allocation`: A boolean which says whether allocation should be used or not;
- `timestep`: a float value in seconds which dictates the update interval for allocations.

## Results settings

The following entries can be set in the configuration in the `[results]` section.

entry | type | description
----------------- | ------ | -----------
compression | String | Compression algorithm: zstd or lz4.
compression_level | Int | Compression level. Higher is more compression.
subgrid | Bool | Compute and output more detailed water levels.

## Logging settings

The following entries can be set in the configuration in the `[logging]` section.

entry | type | description
----------------- | ------ | -----------
verbosity | String | Verbosity level: debug, info, warn, or error.
timing | Bool | Enable timings.

# GeoPackage database and Arrow tables

The input and output tables described below all share that they are tabular files. The Node
Expand Down

0 comments on commit 4522f44

Please sign in to comment.