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

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

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

• centre (BoM, 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-01-01 or ...)
          
          • hindcast dates (2013-09-01, 2013-09-06, 2013-09-11, 2013-09-16,  2013-09-21, 2013-09-26, ...)
            •  time and steps
              • members (for perturbed forecast)
                • levels (for pl or pt)
                  • parameters

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

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.

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.

At this point you may wish to check BoM availabilitye and to view a BoM request

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

The request below is for all members of the perturbed forecast, for Geopotential height and temperature, for the pressure levels 500/700/850/925/1000,  for time-steps  24/to/720/by/24 and for model version 2014-01-01

#!/usr/bin/env python
from ecmwfapi import ECMWFDataServer

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

server.retrieve({
    "class": "s2",
    "dataset": "s2s",
    "date": modelVersionDate,
    "expver": "prod",
    "hdate": hindcastDate, 
    "levtype": "pl",
    "levelist": "500/700/850/925/1000",
    "origin": "ammc",
    "param": "130/156",
    "step": "24/to/720/by/24",
    "stream": "enfh",
    "target": "data.pf.sfc",
    "time": "00",
    "number": "1/2/3",
    "type": "pf",
})

• The objective of this example is to demonstrate how to iterate efficiently over all the available hindcastYears, hindcastMonths and hindcastDays for a BoM 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 needs eg to set the keyword values according to your requirements ("param", "levtype", "step" etc).
• In this way you can extend this request to download the whole S2S BoM reforecast. Don't forget to check BoM availability

 Please note:

• 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"
  

#!/usr/bin/env python
from ecmwfapi import ECMWFDataServer
server = ECMWFDataServer()

def retrieve_BoM_reforecast():
    """
       A function to demonstrate how to iterate efficiently over all hincastYears, hincastMonths etc
    """
    hindcastYearStart = 1981
    hindcastYearEnd = 2013
    hindcastMonthStart = 1
    hindcastMonthEnd = 12
    hincastDays = ["01", "06", "11", "21", "26"]
    for hindcastYear in list(range(hindcastYearStart, hindcastYearEnd + 1)):
        for hindcastMonth in list(range(hindcastMonthStart, hindcastMonthEnd + 1)):
            hindcastDates = []    
            for hindcastDay in hincastDays:
                hindcastDate = '%04d%02d%s' % (
                    hindcastYear, hindcastMonth, hindcastDay)
                hindcastDates.append(hindcastDate)
            target = "data_s2s_ammc_%04d%02d.grb" % (hindcastYear, hindcastMonth)
            BoM_reforecast_request("/".join(hindcastDates), target)

def BoM_reforecast_request(hindcastDates, target):
    """
       A BoM reforecast requests. Change the keywords below to adapt it to your needs.
    """
    modelVersionDate = "2014-01-01"
    server.retrieve({
        "class": "s2",
        "dataset": "s2s",
        "date": modelVersionDate,
        "expver": "prod",
        "hdate": hindcastDates,
        "levtype": "pl",
        "levelist": "500/700/850/925/1000",
        "origin": "ammc",
        "param": "130/156",
        "step": "24/to/720/by/24",
        "stream": "enfh",
        "target": target,
        "time": "00",
        "number": "1/2/3",
        "type": "pf",
    })
if __name__ == '__main__':
    retrieve_BoM_reforecast()
  

• BoM re-forecast requests
• ECMWF Web API Home
• BoM re-forecast availability
• A brief description of reforecasts