update docs, examples

MetPX · Jun 25, 2024 · 2d7b79a · 2d7b79a
1 parent 38b0d6b
commit 2d7b79a
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 387 deletions.
diff --git a/sarracenia/examples/poll/nasa_cmr_opendap.conf b/sarracenia/examples/poll/nasa_cmr_opendap.conf
@@ -4,8 +4,8 @@ post_exchange xs_NASA-TEST
 # How often to poll
 sleep 15m
 
-# Use the poll_NASA_CMR plugin
-callback poll.poll_NASA_CMR
+# Use the NASA CMR poll plugin
+callback poll.nasa_cmr
 
 pollUrl https://cmr.earthdata.nasa.gov/search/granules.umm_json
 
@@ -40,5 +40,5 @@ timeNowMinus 8h
 # No filename/path filtering, post all URLs found 
 acceptUnmatched True
 
-# Enable DEBUG level logging in the poll_NASA_CMR plugin only
-set poll.poll_NASA_CMR.logLevel debug
+# Enable DEBUG level logging in the NASA CMR plugin only
+set poll.nasa_cmr.logLevel debug
diff --git a/sarracenia/examples/poll/nasa_cmr_other.conf b/sarracenia/examples/poll/nasa_cmr_other.conf
@@ -4,8 +4,8 @@ post_exchange xs_NASA-TEST
 # How often to poll
 sleep 15m
 
-# Use the poll_NASA_CMR plugin
-callback poll.poll_NASA_CMR
+# Use the NASA CMR poll plugin
+callback poll.nasa_cmr
 
 pollUrl https://cmr.earthdata.nasa.gov/search/granules.umm_json
 
@@ -34,5 +34,5 @@ timeNowMinus 8h
 # No filename/path filtering, post all URLs found 
 acceptUnmatched True
 
-# Enable DEBUG level logging in the poll_NASA_CMR plugin only
-set poll.poll_NASA_CMR.logLevel debug
+# Enable DEBUG level logging in the NASA CMR plugin only
+set poll.nasa_cmr.logLevel debug
diff --git a/sarracenia/examples/poll/nasa_cmr_podaac.conf b/sarracenia/examples/poll/nasa_cmr_podaac.conf
@@ -4,8 +4,8 @@ post_exchange xs_NASA-TEST
 # How often to poll
 sleep 15m
 
-# Use the poll_NASA_CMR plugin
-callback poll.poll_NASA_CMR
+# Use the NASA CMR poll plugin
+callback poll.nasa_cmr
 
 pollUrl https://cmr.earthdata.nasa.gov/search/granules.umm_json
 
@@ -34,5 +34,5 @@ timeNowMinus 8h
 # No filename/path filtering, post all URLs found 
 acceptUnmatched True
 
-# Enable DEBUG level logging in the poll_NASA_CMR plugin only
-set poll.poll_NASA_CMR.logLevel debug
+# Enable DEBUG level logging in the NASA CMR plugin only
+set poll.nasa_cmr.logLevel debug
diff --git a/sarracenia/flowcb/poll/nasa_cmr.py b/sarracenia/flowcb/poll/nasa_cmr.py
@@ -18,7 +18,7 @@
 .. IMPORTANT::
     Most URLs posted by this plugin will require an Earthdata account to download the data.
     https://urs.earthdata.nasa.gov/  The corresponding download configuration (e.g. a sarra or
-    subscribe config) will need to use the ``auth_NASA_Earthdata`` after_accept plugin.
+    subscribe config) will need to use the ``authenticate.nasa_earthdata`` plugin.
 
 This code is based on https://github.com/podaac/tutorials/blob/master/notebooks/opendap/MUR-OPeNDAP.ipynb
 
@@ -128,16 +128,17 @@
 How to set up your poll config:
 --------------------------------
  
-    Use ``callback poll.poll_NASA_CMR``, and read about the config options above.
+    Use ``callback poll.nasa_cmr``, and read about the config options above.
     
-    For examples, see https://github.com/MetPX/sarracenia/tree/main/sarracenia/examples/poll files named ``*nasa_cmr*.conf``. 
+    For examples, see https://github.com/MetPX/sarracenia/tree/development/sarracenia/examples/poll files named ``*nasa_cmr*.conf``. 
 
 Change log:
 -----------
 
     - 2023-10-10: finished porting poll code, now the poll is in a working state.
     - 2023-06-29: ported to sr3, split into poll_NASA_CMR (incomplete) and download plugin.
     - 2023-06-14: added ``other`` dataSource. Renamed to nasa_cmr from nasa_opendap.
+    - 2024-06-25: bug fixes, renamed from Poll_NASA_CMR to nasa_cmr.
 """
 
 import sarracenia