TNO Intern

Commit 939ce18e authored by Arjo Segers's avatar Arjo Segers
Browse files

Updated documenation.

parent d03fca56

py/cso_earthaccess.py

+14 −8
Original line number Diff line number Diff line
@@ -421,16 +421,17 @@ class CSO_EarthAccess_Inquire(utopya.UtopyaRc): 
class CSO_EarthAccess_Download(utopya.UtopyaRc):



    """

    Download EarthAccess observations.

    Download data from NASA EarthData portal using `EarthAccess <https://earthaccess.readthedocs.io/>`_ package.

    

    Arguments:

    To be able to download data, an account has to be created on `EarthData Login <https://urs.earthdata.nasa.gov/>`_.

    Store the login name and password in the ``~/.netrc`` file in your home directory

    (or in a file defined by the ``NETRC`` environment variable) as::

    

    * ``rcfile``, ``rcbase``, ``env``  :  settings file, prefix for keys, and environment dictionairy

        machine  urs.earthdata.nasa.gov   login your.name@inst.nx  password ********



    A time range is read to select the files to be converted::

    The download class is initialized by arguments:



      <rcbase>.timerange.start        :  2018-06-01 00:00

      <rcbase>.timerange.end          :  2018-06-03 23:59

    * ``rcfile``, ``rcbase``, ``env``  :  settings file, prefix for keys, and environment dictionairy



    The input files are searched in a table created by the

    :py:class:`CSO_EarthAccess_Inquire <.CSO_EarthAccess_Inquire>` class,
@@ -445,6 +446,11 @@ class CSO_EarthAccess_Download(utopya.UtopyaRc): 
        !! date used in filename, leave empty for today:

        !<rcbase>.inquire.filedate               :  2022-01-28



    A time range is read from the settings to select data::



      <rcbase>.timerange.start        :  2018-06-01 00:00

      <rcbase>.timerange.end          :  2018-06-03 23:59



    Provide a ';'-seperated list of expressions to decide if a particular file should be processed.

    If more than one file is available for a particular orbit, for example from different processing versions,

    then the file with the first match will be used.
@@ -622,7 +628,7 @@ class CSO_EarthAccess_Download(utopya.UtopyaRc): 


            # login; this searches for name/password in ~/.netrc

            # (or the file named by "NETCDF" environment variable):

            #    machine  urs.earthdata.nasa.gov   login your.name@inst.nx  password ww4EarthData#

            #    machine  urs.earthdata.nasa.gov   login your.name@inst.nx  password ********

            earthaccess.login()



            # download into current directory: