Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Image Removed

Table of Contents

 

***************  This page is under construction!    *****************

Image Added

  What is the objective of this page?

 

Info

To help users to improve S2S CMA MARS requests performance via the WebAPI.

(lightbulb) A good understanding of the MARS efficiency issues is essential especially for users that are interested in downloading large amounts of data.

How is the S2S reforecast data organised in MARS?

...

Info

In general it is organised, as a huge tree, with the indentation below, showing different levels down that tree:

  • centre (CMA, ECMWF, NCEP, JMA, ...)
    • realtime or reforecast
      •  type of data (control forecast or perturbed forecast)
        • type of level (single level or pressure level or potential  temperature)
          • model version date (2014-05-01 or ...)
            • hindcast dates (2014-01-01 or 2014-01-02 or 2014-01-03, ...)
              •  time-steps
                • members (for perturbed forecast)
                  • levels (for pl or pt)
                    • parameters

...

What would be the natural way to group requests?

Info

The idea is to request as much data as possible from the same tape file. The natural way to group requests would be:
all parameters, all levels, all members, all time-steps for 1 hindcast date for a type of level for a type

(warning) Note the following:

  1. 'all' means 'all' that the user wants. It doesn't have to be all parameters.
  2. If a user is interested only on z500,  he may request more hindcast dates in one go, since the overall request will not be so big.

...

Best practise to iterate over all hindcastDates of several hindcastYears for CMA

Info

(lightbulb) The best approach is to iterate over the hindcastYears. For each hindcastYear iterate over all the available hindcastMonths and for each hindcastMonth iterate over all the available hindcastDays.

(warning) At this point you may wish to check CMA availability and to view a CMA request

...

Info
for hindcastYear in hindcastYears
for hindcastMonth in hindcastMonths
for hindcastDay in hindcastDays
hindcastDate = HindcastYear-hindcastMonth-hindcastDay
S2S-request(hindcastDate)

 

Web-API examples:

A CMA reforecast request for one hindcastDate

Info

The request below is for all members of the perturbed forecast, 10 meter U and V wind components, for all time-steps and for model version 2014-05-01

...

Code Block
languagepy
#!/usr/bin/env python
from ecmwfapi import ECMWFDataServer

modelVersionDate = "2014-05-01"  # This is the first model version for CMA (babj)
hindcastDate = "2014-04-01"      # The selected hindcast date
server = ECMWFDataServer()

server.retrieve({
    "class": "s2",
    "dataset": "s2s",
    "date": modelVersionDate,
    "expver": "prod",
    "hdate": hindcastDate, 
    "levtype": "sfc",
    "origin": "babj",
    "param": "165/166",
    "step": "24/to/1440/by/24",
    "stream": "enfh",
    "target": "data.pf.sfc",
    "time": "00",
    "number": "1/2/3",
    "type": "pf",
})

...

A CMA reforecast request for

...

all the available hindcastDates

Info
  • The objective of this example is to demonstrate how to make a request efficient by iterating properly over several iterate efficiently over all the available hindcastYears, hindcastMonths and hindcastDays for a CMA reforecast request
  • It can be used as a starting point, however you need to keep in mind that you have to adapt it to your needseg to set the keyword values (eg hindcastYear according to your requirements ("param", "levtype", "step" etc).
  • In this way you can extend this request to download the whole S2S CMA reforecast,  but don. Don't forget to check CMA availability (warning)

(warning) Please note: use

  • set the variable "target"  to write each hindcastDate on a separate file .
  • taking under consideration your request's size (eg nr of fields and volume) 

...

  • you can merge several hindcastDates on the same "target" (smile)
v1.0
Code Block
languagepy
#!/usr/bin/env python
import calendar
from ecmwfapi import ECMWFDataServer
server = ECMWFDataServer()

originhindcastYearStart = "babj"1994
modelVersionDatehindcastYearEnd = "2014-05-01"2014
hindcastMonthStart = 1
hindcastMonthEnd = 12

def retrieve_cma_datareforecast(hindcastDate,modelVersionDate,centre):
    targetfor = "target_s2s_%s_%s.grb" % centre % hindcastDatehindcastYear in list(range(hindcastYearStart, hindcastYearEnd + 1)):
    server.retrieve({
    for hindcastMonth in list(range(hindcastMonthStart, hindcastMonthEnd + 1)):
        "class": "s2",    numberOfDays = calendar.monthrange(hindcastYear, hindcastMonth)[1]
       "dataset": "s2s",
    for hindcastDay  "date": modelVersionDate,in list(range(numberOfDays)):
       "expver": "prod",
       "hdate": hindcastDate, = '%04d%02d%02d' % (
       "levtype": "sfc",
             "origin": centre,
hindcastYear, hindcastMonth, hindcastDay + 1)
        "param": "165",
       "step": "0",cma_reforecast_request(hindcastDate)

def cma_reforecast_request(hindcastDate):
    modelVersionDate = "2014-05-01"
    target  = "stream": "enfh",
data_s2s_%s.grb" % (hindcastDate)
    server.retrieve({
        "targetclass": target"s2",
        "timedataset": "00s2s",
        "typedate": "cf"modelVersionDate,
})

hindcastYearList = ["2012", "2013"]
hindcastMonthList = ["08", "09"]
hindcastDayList = ["01expver",: "02prod"],

for hindcastYear in hindcastYearList:
   for hindcastMonth in hindcastMonthList:"hdate": hindcastDate,
       for hindcastDay in hindcastDayList:
"levtype": "sfc",
        "origin": "babj",
   hindcastDate = hindcastYear + hindcastMonth + hindcastDay"param": "165/166",
        "step": "24/to/1440/by/24",
      retrieve_data(hindcastDate)

Some further help for setting BoM hindcast dates

Code Block
languagepy
titleBoM
for hindcastYear in ["2012stream",: "2013enfh"]:,
    for hindcastMonth in ["08", "09target"]: target,
         for hindcastDay in ["01"  "06" "11" "16" "21" "26"]:"time": "00",
        "number": "1/2/3",
          "type": "pf",
  hindcastDate = hindcastYear+hindcastMonth+hindcastDay
      })

if __name__ == '__main__':
       retrieve_data(hindcastDate,"2014-01-01","ammc")

...

cma_reforecast()


Useful links

Info

 

 

 

 

 

 

  *****************************************************************************************************