Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Introduction

The Web API provides a way to access ECMWF's data archives in batch from outside ECMWF (users working at ECMWF or through ecgate should use their normal local MARS access). See A brief guide to the Web API for more information, including how to set up the service. Metview versions from 4.4.3 onwards have support for this service (but version 4.4.7 is recommended). See the Releases page for download.

Setup

First, ensure that you have access to this service by following the steps in the page linked to above. Ensure that you have set up your ~/.ecmwfapirc key and that you are registered for the datasets you wish to access. If you can retrieve some data using a sample script provided there, then you are 90% of the way to accessing the service from within Metview.

Second, ensure that your Metview installation was built with Mars Web Access enabled. When configuring with CMake (Metview version 4.5.x), Mars Web Access will be automatically enabled if the curl development library is found on the system. When configuring with autotools (Metview version 4.4.x), the option is --enable-mars-web-access and is enabled by default. The only reason for disabling this option is if your system does not have the curl development library (libcurl) installed.

Using

Data can be retrieved using the Mars Retrieval icon or its Macro language equivalent, the retrieve() function. Either start with a supplied example icon, or create a new instance, either from the icon drawers at the bottom of the Metview desktop, or from the New Icon context menu. Edit the icon by selecting Edit from its context menu (or double-click the icon).

The important parameters to set in order to use the Web API are Database (should be set to 'Data Server' for the public datasets, or 'Web API' for the core MARS archive) and Dataset. Otherwise, the retrieval should be as described in the Web API guide. It may be useful to create a Mars Retrieval icon with the Database parameter set, and put it into an icon drawer (at the bottom of the Metview desktop) or the Mars Retrieval icon template drawer for future re-use.

To perform the retrieval, use the context menu of the icon: Execute will retrieve and cache the data; Visualise, Examine and Save will do the same, but will then perform more actions on the data. Please see the introductory Metview Tutorials for more information on how to use these features of Metview.

Example retrievals

It is beyond the scope of the Metview documentation to give detailed assistance on formulating MARS requests. Please see the MARS Web API page: A guide for new users. However, here are some examples to help get things started.

Users who have started Metview for the first time with version 4.4.x onwards should already have some example icons and a macro in their Getting Started folder. The icons are also available for separate download - untar these into a Metview folder to start exploring them.

Example retrieval for TIGGE data (icon parameters)

The following is the text behind an example Mars Retrieval icon for requesting TIGGE data. Either copy the values shown into the appropriate places in the icon editor, or switch the icon editor to Text View mode and copy the request in its entirety.

RETRIEVE,
  DATASET = tigge,
  TYPE = PF,
  LEVTYPE = SFC,
  PARAM = TP,
  DATE = 20071001,
  STEP = 12,
  NUMBER = ALL,
  GRID = 1.5/1.5,
  DATABASE = Data Server

Example retrieval for core archive data (icon parameters)

RETRIEVE,
    PARAM      = T,
    DATE       = -2,
    GRID       = 1/1,
    DATABASE   = Web API

Example retrieval for ERA Interim data (Macro language code)

The following Macro code retrieves some ERA Interim data and plots it.

# Metview Macro

#  **************************** LICENSE START ***********************************
# 
#  Copyright 2014 ECMWF. This software is distributed under the terms
#  of the Apache License version 2.0. In applying this license, ECMWF does not
#  waive the privileges and immunities granted to it by virtue of its status as
#  an Intergovernmental Organization or submit itself to any jurisdiction.
# 
#  ***************************** LICENSE END ************************************
# 

data = retrieve
(
    dataset  : "interim",
    class    : "ei",
    type     : "fc",
    levtype  : "sfc",
    param    : 235,
    date     : 20130501,
    step     : 12,
    grid     : [1.5,1.5],
    database : "Data Server"
)

plot(data)

Creating a Mars Retrieval icon

The following images are taken from the new Desktop user interface, but the procedure is the same with the classic user interface. Note that prior to version 4.4.7, the New Icon menu did not allow the creation of Mars Retrieval icons outside ECMWF; in this case, one can be found in the Data Access icon drawer.

  1. Right-click / Create new Icon
2. Select Mars Retrieval
3. The new icon appears on the Metview desktop4. Edit the icon to set the retrieval parameters

 

 

 

  • No labels