Changeset f20342a in flex_extract.git for For_developers/Sphinx/source/Ecmwf


Ignore:
Timestamp:
May 27, 2020, 8:01:54 PM (4 years ago)
Author:
Petra Seibert <petra.seibert [at) univie.ac.at>
Branches:
master, ctbto, dev
Children:
550435b
Parents:
a14839a
Message:

Language corrections for the Sections Developers, Support, Changelog, and the home directory (index.html)

further improvment of documentation, close to final

Location:
For_developers/Sphinx/source/Ecmwf
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • For_developers/Sphinx/source/Ecmwf/access.rst

    rba99230 rf20342a  
    11************
    2 Access Modes
     2Access modes
    33************
    44
     
    88.. _CDS API: https://cds.climate.copernicus.eu/api-how-to
    99
    10 Access to the ECMWF Mars archive is divided into two groups: **member state** users and **public** users.
     10Access to the ECMWF MARS archive is divided into two groups: **member state** users and **public** users.
    1111
    12 **Member state user**:
    13     This access mode allows the user to work directly on the ECMWF Linux Member State Servers or via a Web Access Toolkit ``ecaccess`` through a local Member State Gateway Server. This enables the user to have direct and full access to the Mars archive. There might be some limitations in user rights such as the declined access to the latest forecasts. This has to be discussed with the `Computing Representative`_. This user group is also able to work from their local facilities without a gateway server in the same way a **public** user would. The only difference is the connection with the Web API. However, this is automatically selected by ``flex_extract``.
     12**Member-state user**:
     13    This access mode allows the user to work directly on a ECMWF member-state Linux server or via the ``ecaccess`` Web-Access Toolkit through a local member-state Gateway server. This enables the user to have direct and full access to the MARS archive. There might be some limitations in user rights, such as no access to the latest forecasts. In case such data are needed, this has to be agreed upon with the national `Computing Representative`_. This user group is also able to work from their local facilities without a gateway server in the same way a **public** user would. The only difference is the connection with the Web API, which, however, is automatically selected by ``flex_extract``.
    1414   
    1515
    1616**Public user**:
    17     This access mode allows every user to access the ECMWF `public datasets`_ from their local facilities. ``Flex_extract`` is able (tested for the use with ``FLEXPART``) to extract the re-analysis datasets such as ERA-Interim and CERA-20C. The main difference to the **member state user** is the method of access with the Web API and the availability of data. For example, in ERA-Interim there is only a 6-hourly temporal resolution instead of 3 hours. The access method is selected by providing the command line argument "public=1" and providing the MARS keyword "dataset" in the ``CONTROL`` file. Also, the user has to explicitly accept the license of the dataset to be retrieved. This can be done as described in the installation process at section :ref:`ref-licence`.   
     17    This access mode allows every user to access the ECMWF `public datasets`_ from their local facilities. ``Flex_extract`` is able to extract the re-analysis datasets such as ERA-Interim and CERA-20C for use with ``FLEXPART`` (tested). The main difference to the **member-state user** is the method of access with the Web API and the availability of data. For example, in ERA-Interim,  only a 6-hourly temporal resolution is available instead of 3 hours. The access method is selected by providing the command line argument "public=1" and providing the MARS keyword "dataset" in the ``CONTROL`` file. Also, the user has to explicitly accept the license of the data set to be retrieved. This can be done as described in the installation process at section :ref:`ref-licence`.   
    1818     
    1919.. note::
    2020   
    21    The availability of the public dataset *ERA5* with the ECMWF Web API was cancelled in March 2019. The oportunity of local retrieval of this dataset was moved to the `Climate Data Store`_ which uses another Web API named `CDS API`_. This Data Store stores the data on explicit webservers for faster and easier access. Unfortunately, for *ERA5* there are only surface level and pressure level data available for *public users*. In the case of a *member user* it is possible to bypass the request to the MARS archive from ECMWF to retrieve the data. ``Flex_extract`` is already modified to use this API so *member user* can already retrieve *ERA5* data while *public users* have to wait until model level are available.
     21   The availability of the public dataset *ERA5* with the ECMWF Web API was cancelled by ECWMF in March 2019. Local retrieval of this dataset now has to use the `Climate Data Store`_ (CDS) with a different Web API called `CDS API`_. CDS stores the data on dedicated web servers for faster and easier access. Unfortunately, for *ERA5*, only surface level and pressure level data are available for *public users* which is not enough to run FLEXPART. For a *member user*, it is possible to pass the request to the MARS archive to retrieve the data. ``Flex_extract`` is already modified to use this API so a *member user* can already retrieve *ERA5* data for FLEXPART while *public users* have to wait until model level are made available.
    2222       
    2323For information on how to register see :ref:`ref-registration`.
  • For_developers/Sphinx/source/Ecmwf/ec-links.rst

    rba99230 rf20342a  
    11################################
    2 Link Collection for Quick finder
     2Link collection
    33################################
    44
    55
    6 ECMWF - General Overview   
     6ECMWF - General overview   
    77    `ECMWF Home <https://www.ecmwf.int/>`_
    88   
    9     `ECMWF Training <https://www.ecmwf.int/en/learning>`_
     9    `ECMWF training <https://www.ecmwf.int/en/learning>`_
    1010   
    11     `General User Documentation <https://software.ecmwf.int/wiki/display/UDOC/User+Documentation>`_
     11    `General user documentation <https://software.ecmwf.int/wiki/display/UDOC/User+Documentation>`_
    1212   
    13     `Software Support <https://confluence.ecmwf.int/display/SUP>`_
     13    `Software support <https://confluence.ecmwf.int/display/SUP>`_
    1414
    1515MARS
    1616    `MARS user documentation <https://confluence.ecmwf.int//display/UDOC/MARS+user+documentation>`_
    1717   
    18     `MARS Keywords <https://software.ecmwf.int/wiki/display/UDOC/MARS+keywords>`_
     18    `MARS keywords <https://software.ecmwf.int/wiki/display/UDOC/MARS+keywords>`_
    1919   
    20     `MARS Content <https://confluence.ecmwf.int/display/UDOC/MARS+content>`_
     20    `MARS content <https://confluence.ecmwf.int/display/UDOC/MARS+content>`_
    2121   
    22     `MARS Actions <https://confluence.ecmwf.int/display/UDOC/MARS+actions>`_
     22    `MARS actions <https://confluence.ecmwf.int/display/UDOC/MARS+actions>`_
    2323   
    24     `Parameter Database <https://apps.ecmwf.int/codes/grib/param-db>`_
     24    `Parameter database <https://apps.ecmwf.int/codes/grib/param-db>`_
    2525 
    2626Registration
    27     `Contact of Computing Representative's <https://www.ecmwf.int/en/about/contact-us/computing-representatives>`_
     27    `Contacts of Computing Representatives <https://www.ecmwf.int/en/about/contact-us/computing-representatives>`_
    2828
    2929    `Public registration for ECMWF Web API <https://software.ecmwf.int/wiki/display/WEBAPI/Access+MARS>`_
    3030       
    31     `CDS Registration <https://cds.climate.copernicus.eu/user/register>`_
     31    `CDS registration <https://cds.climate.copernicus.eu/user/register>`_
    3232
    33 Available Member State Datasets
    34     `Web Interface for accessing member state datasets <http://apps.ecmwf.int/archive-catalogue/>`_
     33Member-State data sets available
     34    `Web interface for accessing member-state data sets <http://apps.ecmwf.int/archive-catalogue/>`_
    3535   
    36     `Available datasets for member state users <https://www.ecmwf.int/en/forecasts/datasets>`_
     36    `Data sets available for member state users <https://www.ecmwf.int/en/forecasts/datasets>`_
    3737   
    38 Available Public Datasets
    39     `Web Interface for accessing public datasets <http://apps.ecmwf.int/datasets/>`_
     38Public data sets available
     39    `Web interface for accessing public data sets <http://apps.ecmwf.int/datasets/>`_
    4040   
    41     `ECMWF's public datasets <https://confluence.ecmwf.int/display/WEBAPI/Available+ECMWF+Public+Datasets>`_
     41    `ECMWF's public data sets <https://confluence.ecmwf.int/display/WEBAPI/Available+ECMWF+Public+Datasets>`_
    4242   
    43     `Public dataset Licences <https://software.ecmwf.int/wiki/display/WEBAPI/Available+ECMWF+Public+Datasets>`_
     43    `Public data set licences <https://software.ecmwf.int/wiki/display/WEBAPI/Available+ECMWF+Public+Datasets>`_
    4444   
    45     `ERA5 public dataset Licence <https://cds.climate.copernicus.eu/cdsapp#!/search?type=dataset>`_
     45    `ERA5 public dataset licence <https://cds.climate.copernicus.eu/cdsapp#!/search?type=dataset>`_
    4646
    4747
    4848Datasets
    4949    Overview
    50         `Complete list of datasets <https://www.ecmwf.int/en/forecasts/datasets>`_
     50        `Complete list of data sets <https://www.ecmwf.int/en/forecasts/datasets>`_
    5151               
    5252        `What is climate reanalysis <https://www.ecmwf.int/en/research/climate-reanalysis>`_
     
    5757        `List of real_time datasets <https://www.ecmwf.int/en/forecasts/datasets/catalogue-ecmwf-real-time-products>`_
    5858
    59         `Atmospheric model - HRES (our typical operational dataset) <https://www.ecmwf.int/en/forecasts/datasets/set-i>`_
     59        `Atmospheric model - HRES (typical operational dataset) <https://www.ecmwf.int/en/forecasts/datasets/set-i>`_
    6060       
    6161        `Atmospheric model - ENS (15-day ensemble forecast) <https://www.ecmwf.int/en/forecasts/datasets/set-iii>`_
     
    6666        `ERA-Interim documentation <https://www.ecmwf.int/en/elibrary/8174-era-interim-archive-version-20>`_
    6767   
    68         `ERA-Interim dataset <https://www.ecmwf.int/en/forecasts/datasets/archive-datasets/reanalysis-datasets/era-interim>`_
     68        `ERA-Interim data set <https://www.ecmwf.int/en/forecasts/datasets/archive-datasets/reanalysis-datasets/era-interim>`_
    6969   
    7070    CERA-20C
    7171        `What is CERA-20C <https://software.ecmwf.int/wiki/display/CKB/What+is+CERA-20C>`_
    7272       
    73         `CERA-20C dataset <https://www.ecmwf.int/en/forecasts/datasets/archive-datasets/reanalysis-datasets/cera-20c>`_
     73        `CERA-20C data set <https://www.ecmwf.int/en/forecasts/datasets/archive-datasets/reanalysis-datasets/cera-20c>`_
    7474           
    7575    ERA5
     
    8484        `ERA5 Documentation <https://software.ecmwf.int/wiki/display/CKB/ERA5+data+documentation>`_       
    8585
    86 Third Party Libraries
    87     `ECMWF Web API Home <https://software.ecmwf.int/wiki/display/WEBAPI/ECMWF+Web+API+Home>`_
     86Third-party libraries
     87    `ECMWF Web API home <https://software.ecmwf.int/wiki/display/WEBAPI/ECMWF+Web+API+Home>`_
    8888
    8989    `Building ECMWF software with gfortran <https://software.ecmwf.int/wiki/display/SUP/2015/05/11/Building+ECMWF+software+with+gfortran>`_
     
    103103   
    104104
    105 Scientific Information
    106     `Octahedral reduced Gaussian Grid <https://confluence.ecmwf.int/display/FCST/Introducing+the+octahedral+reduced+Gaussian+grid>`_
     105Scientific information
     106    `Octahedral reduced Gaussian grid <https://confluence.ecmwf.int/display/FCST/Introducing+the+octahedral+reduced+Gaussian+grid>`_
    107107   
    108108    `Precipitation <https://www.ecmwf.int/en/newsletter/147/meteorology/use-high-density-observations-precipitation-verification>`_
    109109
    110110
    111 Technical Information of ECMWF serves
     111Technical information for ECMWF servers
    112112
    113     `Introduction presentation to SLURM  <https://confluence.ecmwf.int/download/attachments/73008494/intro-slurm-2017.pdf?version=1&modificationDate=1488574096323&api=v2>`_
     113    `Introductary presentation of SLURM  <https://confluence.ecmwf.int/download/attachments/73008494/intro-slurm-2017.pdf?version=1&modificationDate=1488574096323&api=v2>`_
    114114
    115 Troubleshooting
    116     `ECMWF Web API Troubleshooting <https://confluence.ecmwf.int/display/WEBAPI/Web-API+Troubleshooting>`_
     115Trouble-shooting
     116    `ECMWF Web API trouble-shooting <https://confluence.ecmwf.int/display/WEBAPI/Web-API+Troubleshooting>`_
    117117
    118118
  • For_developers/Sphinx/source/Ecmwf/hintsecmwf.rst

    rba99230 rf20342a  
    11##################################
    2 Hints to specify dataset retrieval
     2Hints for data set selection
    33##################################
    44
     
    88
    99
    10 How can I find out what data is available?
     10How can I find out what data are available?
    1111==========================================
    1212
    13 Go to the `Web Interface for accessing member state datasets <http://apps.ecmwf.int/archive-catalogue/>`_
     13Go to the `Web Interface for accessing member-state data sets <http://apps.ecmwf.int/archive-catalogue/>`_
    1414and click yourself through the steps to define your set of data and see what is available to you.
    1515
    16 For public users there is  the `Web Interface for accessing public datasets <http://apps.ecmwf.int/datasets/>`_.
     16For public users there is  the `Web Interface for accessing public data sets <http://apps.ecmwf.int/datasets/>`_.
    1717
    1818
  • For_developers/Sphinx/source/Ecmwf/msdata.rst

    rba99230 rf20342a  
    1 #########################################
    2 Available Datasets for Member State users
    3 #########################################
     1##########################################
     2Available data sets for member-state users
     3##########################################
    44
    55
    66
    7 Model level data
     7Model-level data
    88================
    99
     
    1111
    1212
    13 Surface level data
     13Surface data
    1414==================
    1515
  • For_developers/Sphinx/source/Ecmwf/pubdata.rst

    rba99230 rf20342a  
    1 Available Datasets for Public users
    2 ***********************************
     1Available data sets for public users
     2************************************
    33
    4   IN PREPARATION
     4  UNDER PREPARATION
    55
    66
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG