X-Git-Url: https://wylark.com/src/infoex-autowx.git/blobdiff_plain/64929d40db7dc9acb29005ac624f8dd13aefc335..87dfcd0c29eb8e8f4ea455449d173e1eecb16922:/README.md

diff --git a/README.md b/README.md
index 258c70a..3a3a29f 100644
--- a/README.md
+++ b/README.md
@@ -37,7 +37,10 @@ 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 [path/to/config-file.ini]`
+`./infoex-autowx.py --config [path/to/config-file.ini] [--dry-run]`
+
+**NOTE: Specifying --dry-run will also not clean up the generated CSV
+file.** This is so that you can debug any issues more easily.
 
 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
@@ -49,32 +52,34 @@ created earlier):
 Configuration File
 ------------------
 
-The configuration file is separated into two parts, the [wxsite]
-portion, and the [ftp] portion.
+The configuration file is separated into two parts, the
+[nrcs]/[mesowest] portion, and the [infoex] portion.
 
-The [wxsite] values describe which NRCS SNOTEL site's data you're after.
-See the next section in this README for instructions on obtaining these
-values.
+The [nrcs]/[mesowest] values describe which NRCS SNOTEL site's data
+you're after.  See the next section in this README for instructions on
+obtaining these values.
 
-The [ftp] values describe your credentials for the InfoEx automated
-weather station FTP server.
+The [infoex] values describe your credentials for the InfoEx automated
+weather station FTP server and other InfoEx-related configuration
+options.
 
-`[wxsite]`  
+`[nrcs]`  
 `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]`  
+`[infoex]`  
 `host = [InfoEx FTP host address]`  
 `uuid = [InfoEx-supplied UUID]`  
 `api_key = [InfoEx-supplied API Key]`  
+`csv_filename = [Arbitrary name of the file that will be uploaded to InfoEx]`  
+`location_uuid = [The UUID used by InfoEx to identify your automated Wx site]`  
 
-Finding Your WXSITE values
---------------------------
+Finding Your NRCS values
+------------------------
 
-To complete the [wxsite] configuration section, you must fill in the
+To complete the [nrcs] configuration section, you must fill in the
 attributes of the NRCS SNOTEL site from which you want to import data.
+
 Here are the steps to do that:
 
 1. Find your station by clicking through this website:
@@ -123,9 +128,34 @@ indicates that I'd like to import "AIR TEMPERATURE OBSERVED" and
 "PRECIPITATION ACCUMULATION" from the NRCS SNOTEL site at Mud Ridge, OR,
 into InfoEx.
 
+Finding your MesoWest values
+----------------------------
+
+To complete the [mesowest] configuration section, you must fill in the
+attributes of the MesoWest station ID from which you want to import
+data.
+
+Here are the steps to do that:
+
+Field names are listed here:
+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.
+
 Version History
 ---------------
 
+- 2.0.0 (Jul 2020)
+
+  Implement MesoWest integration.
+
+  This release also makes significant changes to the configuration file,
+  hence the major version bump. Such changes are not taken lightly but
+  given the desire to support multiple data sources, were necessary.
+
 - 1.0.0 (Jun 2020)
 
   First released version. Cleaned up the program and design.