From: Alexander Vasarab Date: Wed, 1 Jul 2020 01:40:49 +0000 (-0700) Subject: A few more README changes X-Git-Tag: v2.0.0^2 X-Git-Url: https://wylark.com/src/infoex-autowx.git/commitdiff_plain/9903624614ea3acbeda56479980cac9011262e3f A few more README changes --- diff --git a/README.md b/README.md index 3b442b5..edd134b 100644 --- a/README.md +++ b/README.md @@ -35,18 +35,26 @@ This design allows you to run a separate program instance for each NRCS or MesoWest weather station from which you'd like to automate the importation of data into your InfoEx subscriber account. +To get started, copy the included example config file +(`config.ini.example` in the root source directoy) and modify the values +for your own use. + To run ad-hoc (be sure to activate the virtual environment, as detailed in the Installation section): `./infoex-autowx.py --config path/to/config-file.ini [--dry-run] [--log-level debug|info|warning]` -**NOTE: Specifying --dry-run will also not clean up the generated CSV -file.** This is so that you can debug any issues more easily. +**NOTE: Specifying --dry-run will not clean up the generated CSV file.** +This is so that you can more easily debug any issues that arise in the +setup process. You can also specify `--log-level` as debug, info, warning. The -resultant log messages will try to be logged to journald, but if that's -not available, they will be printed to stdout. This output can be -helpful early on in the setup process. +log messages produced by the program will try to be logged to journald, +but if that's not available, they will be printed to stdout. This output +can be helpful early on in the setup process. + +Automation +---------- Here's an example of a crontab(5) with two SNOTEL sites, each of which will run once per hour (note that this will activate the virtual environment @@ -129,7 +137,7 @@ Once you've chosen your elements, combine all of their respective "elementCd" values into a comma-delimited string and put that into your configuration file as the `desired_data` value. -A complete example: +A complete [station] section example: `[station]` `type = nrcs` @@ -165,12 +173,12 @@ you want to import data. Here are the steps to do that: https://developers.synopticdata.com/about/station-variables/ -The MesoWest API supports on-the-fly unit conversion, so that can be -specified to infoex-autowx via the configuration option `units`. This -can be either 'english' or 'metric', with 'english' meaning imperial -units as used in the United States. +The MesoWest API supports on-the-fly unit conversion. If desired, that +can be specified to infoex-autowx via the configuration option `units`. +This can be either 'english' or 'metric', with 'english' meaning +imperial units as used in the United States. -A complete example: +A complete [station] section example: `[station]` `type = mesowest`