Trying to always mention MesoWest with NRCS

[infoex-autowx.git] / README.md

diff --git a/README.md b/README.md
index 91c4b9848810d65c93b819a8b2c8991ca588253a..781057c750b022c4549bb977c05164db4ddac277 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,17 +1,18 @@
 InfoEx AutoWx (IEAW)
 =============
 
 InfoEx AutoWx (IEAW)
 =============
 

-This program fetches data from an NRCS SNOTEL site and pushes it into
-the InfoEx system using the new automated weather system implementation.
+This program fetches data from an NRCS SNOTEL or MesoWest station and
+pushes it into the InfoEx system using the new automated weather system
+implementation.

 
 

-License under the MIT license (see file: LICENSE).
+License under the ISC license (see file: LICENSE).

 
 Disclaimer
 ----------
 
 
 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.
+Your usage of the NRCS, MesoWest, and/or InfoEx systems is bound by
+their respective terms and this software makes no attempt or claim to
+abide by any such terms.

 
 Installation
 ------------
 
 Installation
 ------------


@@ -31,8 +32,8 @@ This program is designed to be run from the command line (or via
 cron(8)) and administered via a simple, concise configuration file.
 
 This design allows you to run a separate program instance for each NRCS
 cron(8)) and administered via a simple, concise configuration file.
 
 This design allows you to run a separate program instance for each NRCS

-weather station from which you'd like to automate the importation of
-data into your InfoEx subscriber account.
+or MesoWest weather station from which you'd like to automate the
+importation of data into your InfoEx subscriber account.

 
 To run ad-hoc (be sure to activate the virtual environment, as detailed in the
 Installation section):
 
 To run ad-hoc (be sure to activate the virtual environment, as detailed in the
 Installation section):


@@ -64,18 +65,18 @@ weather station FTP server and other InfoEx-related configuration
 options.
 
 `[station]`  
 options.
 
 `[station]`  

-`type = [either mesowest or nrcs]`  
-`token = [MesoWest API token -- ignored when type is nrcs]`  
-`station_id = [the NRCS/MesoWest identifier for a particular station]`  
-`desired_data = [a comma-delimited list of fields you're interested in]`  
-`units = [either english or metric -- ignored when type is nrcs]`  
+`type = # either mesowest or nrcs #`  
+`token = # MesoWest API token -- ignored when type is nrcs #`  
+`station_id = # the NRCS/MesoWest identifier for a particular station #`  
+`desired_data = # a comma-delimited list of fields you're interested in #`  
+`units = # either english or metric -- ignored when type is nrcs #`  

 
 `[infoex]`  
 
 `[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]`  
+`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 NRCS `station` values
 ----------------------------------
 
 Finding Your NRCS `station` values
 ----------------------------------


@@ -123,8 +124,10 @@ 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.
 
 "elementCd" values into a comma-delimited string and put that into your
 configuration file as the `desired_data` value.
 

-For example:
+A complete example:

 
 

+`[station]`  
+`type = nrcs`  

 `station_id = 655:OR:SNTL`  
 `desired_data = TOBS,PREC`
 
 `station_id = 655:OR:SNTL`  
 `desired_data = TOBS,PREC`
 


@@ -162,10 +165,12 @@ 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.
 
 can be either 'english' or 'metric', with 'english' meaning imperial
 units as used in the United States.
 

-For example:
+A complete example:

 
 

-`token = (token id located in your MesoWest web account)`  
-`stid = OD110`  
+`[station]`  
+`type = mesowest`  
+`token = # token id copied from MesoWest web account #`  
+`station_id = OD110`  

 `desired_data = air_temp,snow_depth`  
 `units = english`
 
 `desired_data = air_temp,snow_depth`  
 `units = english`