|
|
|
**Table of Contents**
|
|
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
|
|
# General Info
|
|
|
|
|
|
After successful installation, a `netatmoqc` command will become available in
|
|
After successful installation, a `netatmoqc` command will become available in
|
|
your environment. However, before you can use `netatmoqc` (apart from the `-h`
|
|
your environment. However, before you can use `netatmoqc` (apart from the `-h`
|
|
option), you will need a configuration file written in the
|
|
option), you will need a configuration file written in the
|
|
[TOML](https://en.wikipedia.org/wiki/TOML) format.
|
|
[TOML](https://en.wikipedia.org/wiki/TOML) format.
|
|
|
|
|
|
Until proper documentation for this file is not ready, please take a look at the
|
|
Please take a look at the
|
|
[docs/config_template.toml](https://source.coderefinery.org/iOBS/wp2/task-2-3/netatmoqc/-/blob/master/docs/config_template.toml) file for further
|
|
[docs/minimal_config_example.toml](https://source.coderefinery.org/iOBS/wp2/task-2-3/netatmoqc/-/blob/master/docs/minimal_config_example.toml) and [docs/more_complete_config_example.toml](https://source.coderefinery.org/iOBS/wp2/task-2-3/netatmoqc/-/blob/master/docs/more_complete_config_example.toml) files for examples of how the configuration file is expected to look like.
|
|
information on how the configuration file should look like.
|
|
|
|
|
|
|
|
|
|
|
|
`netatmoqc` will use the following as configuration file (whichever is first
|
|
`netatmoqc` will use the following as configuration file (whichever is first
|
|
encountered):
|
|
encountered):
|
|
|
|
|
|
1. A *full file path* specified via the `NETATMOQC_CONFIG_PATH` envvar
|
|
1. A *full file path* specified via the `NETATMOQC_CONFIG_PATH` envvar
|
|
2. A `config.toml` file located at the current directory
|
|
2. A `config.toml` file located at the current directory
|
|
3. `$HOME/.netatmoqc/config.toml` |
|
3. `$HOME/.netatmoqc/config.toml`
|
|
\ No newline at end of file |
|
|
|
|
|
|
|
|
|
# Minimal Config Requirements
|
|
|
|
|
|
|
|
Most config options have defaults. A [config file with the minimally required options](https://source.coderefinery.org/iOBS/wp2/task-2-3/netatmoqc/-/blob/master/docs/minimal_config_example.toml) will look like this (the DTGs here are, of course, arbitrary):
|
|
|
|
|
|
|
|
```toml
|
|
|
|
[general]
|
|
|
|
data_rootdir="$SOME/PATH/TO/MY/DATA/ROOTDIR"
|
|
|
|
dtgs.list = ['2018040100']
|
|
|
|
```
|
|
|
|
|
|
|
|
or, if you prefer/need to pass a *DTG range* instead of a list:
|
|
|
|
|
|
|
|
```toml
|
|
|
|
[general]
|
|
|
|
data_rootdir="$SOME/PATH/TO/MY/DATA/ROOTDIR"
|
|
|
|
dtgs.start = '2018040100'
|
|
|
|
dtgs.end = '2018040121'
|
|
|
|
```
|
|
|
|
|
|
|
|
See [the Wiki section on input file paths](input-data-format-and-paths#input-file-paths) to know more about the `data_rootdir` config option.
|
|
|
|
|
|
|
|
# Further Config Options
|
|
|
|
|
|
|
|
All config options, except those presented in the [Minimal Config Requirements](#minimal-config-requirements). To see what config options are currently being applied to your `netatmoqc` run, please execute
|
|
|
|
|
|
|
|
netatmoqc show --config
|
|
|
|
|
|
|
|
All currently used configs will be printed by this command (including the configs you've explicitly set, if any).
|
|
|
|
|
|
|
|
For a more complete example of a config file, with some extra comments, please take a look at the file
|
|
|
|
[docs/minimal_config_example.toml](https://source.coderefinery.org/iOBS/wp2/task-2-3/netatmoqc/-/blob/master/docs/minimal_config_example.toml). |
|
|
|
\ No newline at end of file |