From 64929d40db7dc9acb29005ac624f8dd13aefc335 Mon Sep 17 00:00:00 2001 From: Alexander Vasarab Date: Sat, 20 Jun 2020 14:02:58 -0700 Subject: [PATCH] Make README a proper markdown file --- README => README.md | 72 +++++++++++++++++++++++---------------------- 1 file changed, 37 insertions(+), 35 deletions(-) rename README => README.md (67%) diff --git a/README b/README.md similarity index 67% rename from README rename to README.md index 39ce7bc..258c70a 100644 --- a/README +++ b/README.md @@ -1,4 +1,3 @@ -============= InfoEx AutoWx (IEAW) ============= @@ -8,25 +7,25 @@ the InfoEx system using the new automated weather system implementation. License under the MIT license (see file: LICENSE). Disclaimer -========== +---------- Your usage of the NRCS and InfoEx systems is bound by their respective terms and this software makes no attempt or claim to abide by any such terms. Installation -============ +------------ It's recommended to use venv and pip with this program. Here's a typical sequence of commands for a new setup: -$ cd /path/to/src -$ python3 -m venv env -$ . env/bin/activate -$ pip install -r requirements.txt +`$ cd /path/to/src` +`$ python3 -m venv env` +`$ . env/bin/activate` +`$ pip install -r requirements.txt` How to use it -============= +------------- This program is designed to be run from the command line (or via cron(8)) and administered via a simple, concise configuration file. @@ -38,17 +37,17 @@ data into your InfoEx subscriber account. To run ad-hoc (be sure to activate the virtual environment, as detailed in the Installation section): - ./infoex-autowx.py --config +`./infoex-autowx.py --config [path/to/config-file.ini]` 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 created earlier): -2 * * * * /usr/bin/env bash -c 'cd /home/user/infoex-autowx && source env/bin/activate && ./infoex-autowx.py --config laurance-lake.ini' -4 * * * * /usr/bin/env bash -c 'cd /home/user/infoex-autowx && source env/bin/activate && ./infoex-autowx.py --config mud-ridge.ini' +`2 * * * * /usr/bin/env bash -c 'cd /home/user/infoex-autowx && source env/bin/activate && ./infoex-autowx.py --config laurance-lake.ini'` +`4 * * * * /usr/bin/env bash -c 'cd /home/user/infoex-autowx && source env/bin/activate && ./infoex-autowx.py --config mud-ridge.ini'` Configuration File -================== +------------------ The configuration file is separated into two parts, the [wxsite] portion, and the [ftp] portion. @@ -60,19 +59,19 @@ values. The [ftp] values describe your credentials for the InfoEx automated weather station FTP server. -[wxsite] -station_triplet = -desired_data = -location_uuid = -csv_filename = +`[wxsite]` +`station_triplet = [The NRCS identifier for a particular SNOTEL site]` +`desired_data = [A comma-delimited list of NRCS elements you're interested in]` +`location_uuid = [The UUID used by InfoEx to identify your automated Wx site]` +`csv_filename = [Arbitrary name of the file that will be uploaded to InfoEx]` -[ftp] -host = -uuid = -api_key = +`[ftp]` +`host = [InfoEx FTP host address]` +`uuid = [InfoEx-supplied UUID]` +`api_key = [InfoEx-supplied API Key]` Finding Your WXSITE values -========================== +-------------------------- To complete the [wxsite] configuration section, you must fill in the attributes of the NRCS SNOTEL site from which you want to import data. @@ -90,7 +89,7 @@ Here are the steps to do that: 4-digit number). 3. Combine your Station ID, state abbreviation, and the network type - "SNTL" to get your station triplet (station_triplet, in the + "SNTL" to get your station triplet (`station_triplet`, in the configuration file). For example: 655:OR:SNTL @@ -113,27 +112,30 @@ can choose. Each returned element has its identifier and a description. 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. +configuration file as the `desired_data` value. For example: -station_triplet = 655:OR:SNTL -desired_data = TOBS,PREC +`station_triplet = 655:OR:SNTL` +`desired_data = TOBS,PREC` indicates that I'd like to import "AIR TEMPERATURE OBSERVED" and "PRECIPITATION ACCUMULATION" from the NRCS SNOTEL site at Mud Ridge, OR, into InfoEx. Version History -=============== +--------------- + +- 1.0.0 (Jun 2020) + + First released version. Cleaned up the program and design. + Implemented configuration file, added LICENSE, README, docs, etc. + +- 0.8.0 (Apr 2020) -1.0.0 (Jun 2020) - * First released version. Cleaned up the program and design. - Implemented configuration file, added LICENSE, README, docs, etc. + First finished (unreleased) version. -0.8.0 (Apr 2020) - * First finished (unreleased) version. +- pre-0.8.0 (Apr 2020) -pre-0.8.0 (Apr 2020) - * First (private) finished implementation with successful NRCS -> - InfoEx importation. + First (private) finished implementation with successful importation of + NRCS data into InfoEx. -- 2.30.2