[GRASS-SVN] r70517 - in grass-addons/grass7/raster/r.modis: r.modis.download r.modis.import

svn_grass at osgeo.org svn_grass at osgeo.org
Thu Feb 9 08:14:52 PST 2017


Author: lucadelu
Date: 2017-02-09 08:14:51 -0800 (Thu, 09 Feb 2017)
New Revision: 70517

Modified:
   grass-addons/grass7/raster/r.modis/r.modis.download/r.modis.download.html
   grass-addons/grass7/raster/r.modis/r.modis.download/r.modis.download.py
   grass-addons/grass7/raster/r.modis/r.modis.import/r.modis.import.html
   grass-addons/grass7/raster/r.modis/r.modis.import/r.modis.import.py
Log:
r.modis: improve documentation, thanks to Veronica Andreo

Modified: grass-addons/grass7/raster/r.modis/r.modis.download/r.modis.download.html
===================================================================
--- grass-addons/grass7/raster/r.modis/r.modis.download/r.modis.download.html	2017-02-09 14:35:23 UTC (rev 70516)
+++ grass-addons/grass7/raster/r.modis/r.modis.download/r.modis.download.html	2017-02-09 16:14:51 UTC (rev 70517)
@@ -6,71 +6,74 @@
 
 <h2>NOTE</h2>
 
-To be able to download data you need user and password provided by NASA.
-Please register at <a href="https://urs.earthdata.nasa.gov/users/new"
+To be able to download data the user needs a <em>user</em> and <em>password</em> 
+provided by NASA. The user should register at <a href="https://urs.earthdata.nasa.gov/users/new"
 target="_blank">https://urs.earthdata.nasa.gov/users/new</a>;
-now login and move to your profile page.
-Go to “My application” tab and approve the following applications
-“LP DAAC Data Pool” and “Earthdata Search”.
+then login and move to his/her profile page. Once there, under 'My applications'
+tab, the user needs to approve the following applications: 'LP DAAC Data Pool' 
+and 'Earthdata Search'.
 <p>
-If you are an already registered user, login and enable the applications
-at <a href="https://urs.earthdata.nasa.gov/home" target="_blank">https://urs.earthdata.nasa.gov/home</a>
+If the user is already registered, he/she just needs to login and enable the 
+mentioned applications at <a href="https://urs.earthdata.nasa.gov/home" target="_blank">https://urs.earthdata.nasa.gov/home</a>
 <p>
-To set the username and password options the user has to use
-the <em>setting</em> option; a file can be used (in this case the first
-line is the username, usually it is 'anonymous', in the second line
-the password is given, usually the user's e-mail address):
+In order to download the desired product(s), the username and password must be
+provided through the <em>settings</em> option. This There are two alternatives; 
+either pass a file in which the first line is the username, usually 'anonymous' 
+and, the second line is the password, usually the user's e-mail address, as below:
 <div class="code"><pre>
   your_NASA_username
   your_NASA_password
 </pre></div>
-As an alternative, the user can pass the values from standard input.
+or, the user can pass the values from the standard input when prompted.
 <p>
 
-<b>Warning</b>: As per NASA policy not more than ten simultaneous connections
-are permitted in parallel with their server. Hence no more than ten processes
+<b>Warning</b>: As per NASA policy no more than ten simultaneous connections
+are permitted in parallel with their server. Hence, no more than ten processes
 of <em>r.modis.download</em> should run at the same time to avoid that your
 actual IP address gets blacklisted.
 <p>
-By default, the downloaded files are stored in the path where the setting
-file is saved. The user can change this directory with <em>folder</em>
-option. The user has to set the <em>folder</em> option if
-user and password are sent by standard input.
+By default, the downloaded files are stored in the path where the settings
+file is saved. The user can change this directory with the <em>folder</em>
+option. The <em>folder</em> option is required when user and password are 
+passed through the standard input.
 <p>
 The needed time for the download depends on the number of requested tiles, days
-and the type of the MODIS product. For example, the NDVI product ranges
-from 5 MB to 270 MB and the LST product ranges from 2 MB to 21 MB.
+and the type of MODIS product. For example, the NDVI product ranges from 5 MB 
+to 270 MB and the LST product ranges from 2 MB to 21 MB.
 
 <h2>EXAMPLES</h2>
 
-To download the MODIS LST product from the Terra satellite using the default
-options and setting the user and password by standard input, launch:
+Download the daily MODIS LST product from the Terra satellite using the default
+options (all available tiles from newest available date) and passing the user 
+and password from standard input. Note that when settings is read from standard 
+input, the option folder must be specified.
 <div class="code"><pre>
-r.modis.download setting=-
+r.modis.download settings=- folder=/tmp 
 </pre></div>
 
-Reading the user and password options from file:
+Reading the user and password options from a file. Images will be downloaded to
+the folder where the SETTING file is.
 <div class="code"><pre>
-r.modis.download setting=$HOME/.grass7/r.modis/SETTING
+r.modis.download settings=$HOME/.grass7/r.modis/SETTING
 </pre></div>
 
-To download LST Terra product using the default options and changing
-the starting and ending dates to custom values:
+Download LST Terra product using the default options and changing the starting
+and ending dates to custom values.
 <div class="code"><pre>
-r.modis.download setting=$HOME/.grass7/r.modis/SETTING startday=2011-05-01 endday=2011-05-31
+r.modis.download settings=$HOME/.grass7/r.modis/SETTING startday=2011-05-01 endday=2011-05-31
 </pre></div>
 
-To download another product (for example <em>Snow eight days 500 m</em>),
-with other default options:
+Download a different product (for example <em>Snow eight days 500 m</em>),
+default options.
 <div class="code"><pre>
-r.modis.download setting=$HOME/.grass7/r.modis/SETTING product=snow_terra_eight_500
+r.modis.download settings=$HOME/.grass7/r.modis/SETTING product=snow_terra_eight_500
 </pre></div>
 
-To use <em>r.modis.download</em> in a script with one of the other module
-the user has to set the <em>-g</em> flag to return the name of the file
-containing a list of downloaded HDF names:
+To use <em>r.modis.download</em> in a script and concatenate with another module,
+the user needs to set the <em>-g</em> flag to return the name of the file that 
+contains the list of downloaded HDF files:
 <div class="code"><pre>
-r.modis.download -g setting=$HOME/.grass7/r.modis/SETTING startday=2011-05-01 endday=2011-05-31
+r.modis.download -g settings=$HOME/.grass7/r.modis/SETTING startday=2011-05-01 endday=2011-05-31
 </pre></div>
 
 <h2>SEE ALSO</h2>

Modified: grass-addons/grass7/raster/r.modis/r.modis.download/r.modis.download.py
===================================================================
--- grass-addons/grass7/raster/r.modis/r.modis.download/r.modis.download.py	2017-02-09 14:35:23 UTC (rev 70516)
+++ grass-addons/grass7/raster/r.modis/r.modis.download/r.modis.download.py	2017-02-09 16:14:51 UTC (rev 70517)
@@ -39,7 +39,7 @@
 #%end
 #%option G_OPT_F_INPUT
 #% key: settings
-#% label: Full path to settings file
+#% label: Full path to settings file or '-' for standard input
 #% required: yes
 #% guisection: Define
 #%end
@@ -55,7 +55,7 @@
 #%option
 #% key: tiles
 #% type: string
-#% label: The name(s) of tile(s) to download (comma separated)
+#% label: The name(s) of tile(s) to download (comma separated). If not set, all available tiles are downloaded.
 #% description: e.g.: h18v04
 #% required: no
 #%end
@@ -63,21 +63,21 @@
 #% key: startday
 #% type: string
 #% label: First date to download
-#% description: Format: YYYY-MM-DD. If not set the download starts from today and go back 10 days. If not endday the download stops 10 days after the endday
+#% description: Format: YYYY-MM-DD. If not set the download starts from current date and goes back 10 days. If not endday is set, the download stops 10 days after the startday
 #% required: no
 #%end
 #%option
 #% key: endday
 #% type: string
 #% label: Last date to download
-#% description: Format: YYYY-MM-DD. To use only together with startday
+#% description: Format: YYYY-MM-DD. To use only with startday
 #% required: no
 #%end
 #%option
 #% key: folder
 #% type: string
 #% label: Folder to store the downloaded data
-#% description: If not set, path of settings file is used
+#% description: If not set, path to settings file is used
 #% required: no
 #%end
 
@@ -142,7 +142,7 @@
         valueDay = lastday.strftime("%Y-%m-%d")
     # set only start day
     elif options['startday'] == '' and options['endday'] != '':
-        grass.fatal(_("It is not possible use <endday> option without "
+        grass.fatal(_("It is not possible to use <endday> option without "
                       "<startday> option"))
     # set start and end day
     elif options['startday'] != '' and options['endday'] != '':

Modified: grass-addons/grass7/raster/r.modis/r.modis.import/r.modis.import.html
===================================================================
--- grass-addons/grass7/raster/r.modis/r.modis.import/r.modis.import.html	2017-02-09 14:35:23 UTC (rev 70516)
+++ grass-addons/grass7/raster/r.modis/r.modis.import/r.modis.import.html	2017-02-09 16:14:51 UTC (rev 70517)
@@ -1,6 +1,6 @@
 <h2>DESCRIPTION</h2>
 
-<em>r.modis.import</em> import Level 3 MODIS product into GRASS GIS.
+<em>r.modis.import</em> imports Level 3 MODIS products into GRASS GIS.
 
 <h2>NOTE</h2>
 
@@ -18,45 +18,45 @@
 
 <b>Warning</b>:
 <ul>
-  <li>Using MODIS Reprojection Tools to convert HDF files only
+  <li>If using MODIS Reprojection Tools to convert HDF files, only
    the following projection systems are supported: Lambert Azimuthal Equal Area,
    Lambert Conformal Conic, Mercator, Polar Stereographic, Transverse Mercator,
    Universal Transverse Mercator</li>
-  <li>Using GDAL you can manage all the projection systems supported by Proj4</li>
+  <li>Using GDAL allows to handle all the projection systems supported by Proj4</li>
 </ul>
 
 <h2>EXAMPLES</h2>
 
-Import a single file with the all the subsets with QA layer analysis to
-remove bad pixels using GDAL:
+Import a single file with all the subsets (QA layers included) using GDAL.
 <div class="code"><pre>
 r.modis.import input=/path/to/file
 </pre></div>
 
-Import more files with the default subset with QA layer using MRT:
+Import files from a list with all the subsets using MRT (if mrtpath is not
+provided, GDAL is used).
 <div class="code"><pre>
 r.modis.import files=/path/to/listfile mrtpath=/path/to/mrt
 </pre></div>
 
-Import more files like daily mosaic with the default subset without QA
-layer check using MRT:
+Import files from a list as mosaics per date without QA layers using MRT.
 <div class="code"><pre>
 r.modis.import -mq files=/path/to/listfile mrtpath=/path/to/mrt
 </pre></div>
 
-Import a single file with your own subset of layers (for power user) using GDAL:
+Import a single file with user-specific subset of layers using GDAL.
 <div class="code"><pre>
 r.modis.import input=/path/to/file spectral="( 1 0 1 0 )"
 </pre></div>
 
-Import more files with your own subset of layers and without QA layer
-analysis (for power users) using MRT:
+Import files from a list with user-specific subset of layers and without QA
+layer using MRT.
 <div class="code"><pre>
 r.modis.import -q files=/path/to/listfile mrtpath=/path/to/mrt spectral="( 1 )"
 </pre></div>
 
-Import more files and write the file to be use in <em>t.register</em>
-to create a temporal dataset using GDAL, you specify only a subset:
+Import a single subset of layers (i.e.: spectral="( 1 )") from each file from a
+list and write a file to be used in <em>t.register</em> to create a temporal
+dataset. This option uses GDAL.
 <div class="code"><pre>
 r.modis.import -wq files=/path/to/listfile spectral="( 1 )"
 </pre></div>
@@ -66,6 +66,7 @@
 <em>
 <a href="r.modis.html">r.modis</a>,
 <a href="r.modis.download.html">r.modis.download</a>
+<a href="i.modis.qc.html">i.modis.qc</a>
 <!-- <a href="r.modis.process.html">r.modis.process</a>,-->
 </em><br>
 <a href="https://lpdaac.usgs.gov/dataset_discovery/modis">Map of MODIS Land products' Sinusoidal grid tiling system</a>

Modified: grass-addons/grass7/raster/r.modis/r.modis.import/r.modis.import.py
===================================================================
--- grass-addons/grass7/raster/r.modis/r.modis.import/r.modis.import.py	2017-02-09 14:35:23 UTC (rev 70516)
+++ grass-addons/grass7/raster/r.modis/r.modis.import/r.modis.import.py	2017-02-09 16:14:51 UTC (rev 70517)
@@ -28,7 +28,7 @@
 #%end
 #%flag
 #% key: m
-#% description: Create a mosaic for each day
+#% description: Create a mosaic for each date
 #%end
 #%flag
 #% key: t
@@ -60,7 +60,7 @@
 #% key: method
 #% type: string
 #% key_desc: resampling
-#% description: Code of spatial resampling method
+#% description: Name of spatial resampling method
 #% options: nearest, bilinear, cubic
 #% answer: nearest
 #% required: no
@@ -77,7 +77,7 @@
 #% key: spectral
 #% type: string
 #% key_desc: spectral subset
-#% description: String to choose subset of layers in HDF file for import
+#% description: String of the form "( 1 0 1 0 )" to choose a subset of HDF layers to import
 #% required: no
 #%end
 



More information about the grass-commit mailing list