Versions Compared

Old Version 100

changes.mady.by.user Matthew Manoussakis

Saved on

compared with

New Version Current

changes.mady.by.user Matthew Manoussakis

Saved on

Key

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

Table of Contents

 Image Removed

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) (lightbulb)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 = HindcastYearhindcastYear-hindcastMonth-hindcastDay               
                S2S-request(hindcastDate)

Web-API examples:

A CMA reforecast request

...

for all

...

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",
})

...

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't forget to check CMA availability (warning)
(warning) Please note: use
  • .

Please note:

  • you can set the variable "target"  to write each hindcastDate on a separate
file .

 

v1.0

  • file (lightbulb)
  • taking under consideration your request's size (eg Nr of fields and volume)  you can merge several hindcastDates on the same "target" (smile)
Code Block
languagepy
#!/usr/bin/env python
import calendar
from ecmwfapi import ECMWFDataServer
server = ECMWFDataServer()

origin = "babj"
modelVersionDate = "2014-05-01"

def retrieve_datacma_reforecast(hindcastDate):
    target = "target_s2s_%s_%s.grb""" % (origin, hindcastDate)
    server.retrieve({
       "class": "s2",
       "dataset": "s2s",
   A function to demonstrate how to iterate efficiently over all hindcastYears, hindcastMonths etc    "date": modelVersionDate,
       "expver": "prod",
  for a particular cma_reforecast_request.     "hdate": hindcastDate,
       "levtype": "sfc",
       "origin": origin,
       "param": "165",
   Change the variables below to adapt the iteration to your needs 
    "step": "0",
    hindcastYearStart   "stream": "enfh",= 1994
    hindcastYearEnd   "target": target,= 2014
    hindcastMonthStart   "time": "00",= 1
    hindcastMonthEnd   "type": "cf",
})

hindcastYearStart = 1994
hindcastYearEnd = 2014
hindcastMonthStart = 1
hindcastMonthrEnd = 12

= 12
    
    for hindcastYear in list(range(hindcastYearStart, hindcastYearEnd + 1)):
        for hindcastMonth in list(range(hindcastMonthStart, hindcastMonthrEndhindcastMonthEnd + 1)):
            numberOfDays = calendar.monthrange(hindcastYear, hindcastMonth)[1]
            for hindcastDay in list(range(1, numberOfDays + 1)):
                hindcastDate = '%04d%02d%02d' % (hindcastYear, hindcastMonth, hindcastDay)
            retrieve_data(hindcastDate) 

v1.1

Code Block
languagepy
#!/usr/bin/env python
import calendar
from ecmwfapi import ECMWFDataServer
server = ECMWFDataServer()

origin = "babj"
modelVersionDate = "2014-05-01"

hindcastYearStart = 1994
hindcastYearEnd = 2014
hindcastMonthStart = 1
hindcastMonthrEnd = 12

def retrieve_cma_reforecast(): hindcastYear, hindcastMonth, hindcastDay + 1)
    for hindcastYear in list(range(hindcastYearStart, hindcastYearEnd + 1)):
      target = for hindcastMonth in list(range(hindcastMonthStart, hindcastMonthrEnd + 1)):
"%s%s.grb" % (origin, hindcastDate)
              numberOfDays = calendar.monthrange(hindcastYear, hindcastMonth)[1]
            for hindcastDay in list(range(1, numberOfDays + 1)) cma_reforecast_request(hindcastDate, target)

def cma_reforecast_request(hindcastDate, target):
    """            hindcastDate = '%04d%02d%02d' % (
        A CMA reforecast request. Change the keywords below to adapt it to hindcastYear, hindcastMonth, hindcastDay)
                cma_reforecast_request(hindcastDate)

def cma_reforecast_request(hindcastDate):your needs.   
    target = "target_s2s_%s_%s.grb" % (origin, hindcastDate)"""
    
    server.retrieve({
        "class": "s2",
        "dataset": "s2s",
        "date": modelVersionDate,
        "expver": "prod",
        "hdate": hindcastDate,
        "levtype": "sfc",
        "origin": origin,
        "param": "165/166",
        "step": "024/to/1440/by/24",
        "stream": "enfh",
        "target": target,
        "time": "00",
        "number": "1/2/3",
        "type": "cfpf",
    })

if __name__ == '__main__':
    retrieve_cma_reforecast()


Useful links

Info