[d69b677] | 1 | #!/usr/bin/env python |
---|
[efdb01a] | 2 | # -*- coding: utf-8 -*- |
---|
[991df6a] | 3 | #******************************************************************************* |
---|
| 4 | # @Author: Anne Fouilloux (University of Oslo) |
---|
| 5 | # |
---|
| 6 | # @Date: October 2014 |
---|
| 7 | # |
---|
| 8 | # @Change History: |
---|
| 9 | # |
---|
| 10 | # November 2015 - Leopold Haimberger (University of Vienna): |
---|
[ff99eae] | 11 | # - moved the getEIdata program into a function "get_mars_data" |
---|
[991df6a] | 12 | # - moved the AgurmentParser into a seperate function |
---|
| 13 | # - adatpted the function for the use in flex_extract |
---|
[ff99eae] | 14 | # - renamed file to get_mars_data |
---|
[991df6a] | 15 | # |
---|
| 16 | # February 2018 - Anne Philipp (University of Vienna): |
---|
| 17 | # - applied PEP8 style guide |
---|
| 18 | # - added structured documentation |
---|
| 19 | # - minor changes in programming style for consistence |
---|
| 20 | # - added function main and moved function calls vom __main__ there |
---|
| 21 | # (necessary for better documentation with docstrings for later |
---|
| 22 | # online documentation) |
---|
| 23 | # - use of UIFiles class for file selection and deletion |
---|
[54a8a01] | 24 | # |
---|
[991df6a] | 25 | # |
---|
| 26 | # @License: |
---|
| 27 | # (C) Copyright 2014-2018. |
---|
| 28 | # |
---|
| 29 | # This software is licensed under the terms of the Apache Licence Version 2.0 |
---|
| 30 | # which can be obtained at http://www.apache.org/licenses/LICENSE-2.0. |
---|
| 31 | # |
---|
| 32 | # @Program Functionality: |
---|
| 33 | # This program can be used as a module in the whole flex_extract process |
---|
| 34 | # or can be run by itself to just extract MARS data from ECMWF. To do so, |
---|
| 35 | # a couple of necessary parameters has to be passed with the program call. |
---|
| 36 | # See documentation for more details. |
---|
| 37 | # |
---|
| 38 | # @Program Content: |
---|
| 39 | # - main |
---|
[ff99eae] | 40 | # - get_mars_data |
---|
[54a8a01] | 41 | # - do_retrievement |
---|
[991df6a] | 42 | # |
---|
| 43 | #******************************************************************************* |
---|
| 44 | |
---|
[efdb01a] | 45 | # ------------------------------------------------------------------------------ |
---|
| 46 | # MODULES |
---|
| 47 | # ------------------------------------------------------------------------------ |
---|
[991df6a] | 48 | import os |
---|
| 49 | import sys |
---|
| 50 | import inspect |
---|
[ca867de] | 51 | from datetime import datetime, timedelta |
---|
[ff99eae] | 52 | |
---|
| 53 | # software specific classes and modules from flex_extract |
---|
[70fee58] | 54 | sys.path.append(os.path.dirname(os.path.abspath( |
---|
| 55 | inspect.getfile(inspect.currentframe()))) + '/../') |
---|
[2fb99de] | 56 | import _config |
---|
[5bad6ec] | 57 | from tools import (my_error, normal_exit, get_cmdline_arguments, |
---|
| 58 | read_ecenv, make_dir) |
---|
[25b14be] | 59 | from classes.EcFlexpart import EcFlexpart |
---|
| 60 | from classes.UioFiles import UioFiles |
---|
[ca867de] | 61 | |
---|
| 62 | try: |
---|
| 63 | ecapi = True |
---|
| 64 | import ecmwfapi |
---|
| 65 | except ImportError: |
---|
| 66 | ecapi = False |
---|
[efdb01a] | 67 | # ------------------------------------------------------------------------------ |
---|
| 68 | # FUNCTION |
---|
| 69 | # ------------------------------------------------------------------------------ |
---|
[991df6a] | 70 | def main(): |
---|
| 71 | ''' |
---|
| 72 | @Description: |
---|
[295ff45] | 73 | If get_mars_data is called directly from command line, |
---|
| 74 | |
---|
[991df6a] | 75 | the program flow and calls the argumentparser function and |
---|
[ff99eae] | 76 | the get_mars_data function for retrieving EC data. |
---|
[991df6a] | 77 | |
---|
| 78 | @Input: |
---|
| 79 | <nothing> |
---|
| 80 | |
---|
| 81 | @Return: |
---|
| 82 | <nothing> |
---|
| 83 | ''' |
---|
[54a8a01] | 84 | |
---|
| 85 | args = get_cmdline_arguments() |
---|
[4971f63] | 86 | c = ControlFile(args.controlfile) |
---|
[54a8a01] | 87 | |
---|
[2fb99de] | 88 | env_parameter = read_ecenv(_config.PATH_ECMWF_ENV) |
---|
[295ff45] | 89 | c.assign_args_to_control(args) |
---|
[54a8a01] | 90 | c.assign_envs_to_control(env_parameter) |
---|
[2fb99de] | 91 | c.check_conditions(args.queue) |
---|
[54a8a01] | 92 | |
---|
[ff99eae] | 93 | get_mars_data(c) |
---|
[54a8a01] | 94 | normal_exit(c.mailfail, 'Done!') |
---|
[d69b677] | 95 | |
---|
[991df6a] | 96 | return |
---|
| 97 | |
---|
[ff99eae] | 98 | def get_mars_data(c): |
---|
[991df6a] | 99 | ''' |
---|
| 100 | @Description: |
---|
| 101 | Retrieves the EC data needed for a FLEXPART simulation. |
---|
| 102 | Start and end dates for retrieval period is set. Retrievals |
---|
| 103 | are divided into smaller periods if necessary and datechunk parameter |
---|
| 104 | is set. |
---|
| 105 | |
---|
| 106 | @Input: |
---|
| 107 | c: instance of class ControlFile |
---|
[27fe969] | 108 | Contains all the parameters of CONTROL file and |
---|
| 109 | command line. |
---|
[991df6a] | 110 | For more information about format and content of the parameter |
---|
| 111 | see documentation. |
---|
| 112 | |
---|
| 113 | @Return: |
---|
| 114 | <nothing> |
---|
| 115 | ''' |
---|
[d69b677] | 116 | |
---|
| 117 | if not os.path.exists(c.inputdir): |
---|
[5bad6ec] | 118 | make_dir(c.inputdir) |
---|
[991df6a] | 119 | |
---|
[2fb99de] | 120 | if c.request == 0 or c.request == 2: |
---|
| 121 | print("Retrieving EC data!") |
---|
| 122 | elif c.request == 1: |
---|
| 123 | print("Printing mars requests!") |
---|
| 124 | |
---|
| 125 | print("start date %s " % (c.start_date)) |
---|
| 126 | print("end date %s " % (c.end_date)) |
---|
[d69b677] | 127 | |
---|
| 128 | if ecapi: |
---|
[5bad6ec] | 129 | if c.public: |
---|
| 130 | server = ecmwfapi.ECMWFDataServer() |
---|
| 131 | else: |
---|
| 132 | server = ecmwfapi.ECMWFService("mars") |
---|
[d69b677] | 133 | else: |
---|
| 134 | server = False |
---|
| 135 | |
---|
[64cf353] | 136 | c.ecapi = ecapi |
---|
[2fb99de] | 137 | print('Using ECMWF WebAPI: ' + str(c.ecapi)) |
---|
[991df6a] | 138 | |
---|
[54a8a01] | 139 | # basetime geht rückwärts |
---|
| 140 | |
---|
| 141 | # if basetime 00 |
---|
| 142 | # dann wird von 12 am vortag bis 00 am start tag geholt |
---|
| 143 | # aber ohne 12 selbst sondern 12 + step |
---|
| 144 | |
---|
| 145 | # if basetime 12 |
---|
| 146 | # dann wird von 00 + step bis 12 am start tag geholt |
---|
| 147 | |
---|
| 148 | # purer forecast wird vorwärts bestimmt. |
---|
| 149 | # purer forecast mode ist dann wenn größer 24 stunden |
---|
| 150 | # wie kann das noch festgestellt werden ???? |
---|
| 151 | # nur FC und steps mehr als 24 ? |
---|
| 152 | # die einzige problematik beim reinen forecast ist die benennung der files! |
---|
| 153 | # also sobald es Tagesüberschneidungen gibt |
---|
| 154 | # allerdings ist das relevant und ersichtlich an den NICHT FLUSS DATEN |
---|
| 155 | |
---|
[ca867de] | 156 | start = datetime.strptime(c.start_date, '%Y%m%d') |
---|
| 157 | end = datetime.strptime(c.end_date, '%Y%m%d') |
---|
| 158 | # time period for one single retrieval |
---|
| 159 | datechunk = timedelta(days=int(c.date_chunk)) |
---|
[efdb01a] | 160 | |
---|
[54a8a01] | 161 | if c.basetime == '00': |
---|
[ca867de] | 162 | start = start - timedelta(days=1) |
---|
| 163 | |
---|
| 164 | if c.maxstep <= 24: |
---|
| 165 | startm1 = start - timedelta(days=1) |
---|
[54a8a01] | 166 | |
---|
| 167 | if c.basetime == '00' or c.basetime == '12': |
---|
[ca867de] | 168 | # endp1 = end + timedelta(days=1) |
---|
[54a8a01] | 169 | endp1 = end |
---|
| 170 | else: |
---|
[ca867de] | 171 | # endp1 = end + timedelta(days=2) |
---|
| 172 | endp1 = end + timedelta(days=1) |
---|
[54a8a01] | 173 | |
---|
[991df6a] | 174 | # -------------- flux data ------------------------------------------------ |
---|
[2fb99de] | 175 | if c.request == 0 or c.request == 2: |
---|
| 176 | print('... removing old flux content of ' + c.inputdir) |
---|
| 177 | tobecleaned = UioFiles(c.inputdir, |
---|
| 178 | '*_acc_*.' + str(os.getppid()) + '.*.grb') |
---|
| 179 | tobecleaned.delete_files() |
---|
[64cf353] | 180 | |
---|
[54a8a01] | 181 | # if forecast for maximum one day (upto 24h) are to be retrieved, |
---|
[efdb01a] | 182 | # collect accumulation data (flux data) |
---|
| 183 | # with additional days in the beginning and at the end |
---|
| 184 | # (used for complete disaggregation of original period) |
---|
[54a8a01] | 185 | if c.maxstep <= 24: |
---|
| 186 | do_retrievement(c, server, startm1, endp1, datechunk, fluxes=True) |
---|
[efdb01a] | 187 | |
---|
| 188 | # if forecast data longer than 24h are to be retrieved, |
---|
| 189 | # collect accumulation data (flux data) |
---|
| 190 | # with the exact start and end date |
---|
| 191 | # (disaggregation will be done for the |
---|
| 192 | # exact time period with boundary conditions) |
---|
[d69b677] | 193 | else: |
---|
[54a8a01] | 194 | do_retrievement(c, server, start, end, datechunk, fluxes=True) |
---|
[991df6a] | 195 | |
---|
| 196 | # -------------- non flux data -------------------------------------------- |
---|
[2fb99de] | 197 | if c.request == 0 or c.request == 2: |
---|
| 198 | print('... removing old non flux content of ' + c.inputdir) |
---|
| 199 | tobecleaned = UioFiles(c.inputdir, |
---|
| 200 | '*__*.' + str(os.getppid()) + '.*.grb') |
---|
| 201 | tobecleaned.delete_files() |
---|
[991df6a] | 202 | |
---|
[54a8a01] | 203 | do_retrievement(c, server, start, end, datechunk, fluxes=False) |
---|
| 204 | |
---|
| 205 | return |
---|
| 206 | |
---|
| 207 | def do_retrievement(c, server, start, end, delta_t, fluxes=False): |
---|
| 208 | ''' |
---|
| 209 | @Description: |
---|
| 210 | Divides the complete retrieval period in smaller chunks and |
---|
| 211 | retrieves the data from MARS. |
---|
| 212 | |
---|
| 213 | @Input: |
---|
[27fe969] | 214 | c: instance of class ControlFile |
---|
| 215 | Contains all the parameters of CONTROL file and |
---|
| 216 | command line. |
---|
[54a8a01] | 217 | For more information about format and content of the parameter |
---|
| 218 | see documentation. |
---|
| 219 | |
---|
| 220 | server: instance of ECMWFService |
---|
| 221 | The server connection to ECMWF |
---|
| 222 | |
---|
| 223 | start: instance of datetime |
---|
| 224 | The start date of the retrieval. |
---|
| 225 | |
---|
| 226 | end: instance of datetime |
---|
| 227 | The end date of the retrieval. |
---|
| 228 | |
---|
| 229 | delta_t: instance of datetime |
---|
| 230 | Delta_t +1 is the maximal time period of a single |
---|
| 231 | retrieval. |
---|
| 232 | |
---|
| 233 | fluxes: boolean, optional |
---|
| 234 | Decides if the flux parameters are to be retrieved or |
---|
| 235 | the rest of the parameter list. |
---|
| 236 | Default value is False. |
---|
| 237 | |
---|
| 238 | @Return: |
---|
| 239 | <nothing> |
---|
| 240 | ''' |
---|
| 241 | |
---|
| 242 | # since actual day also counts as one day, |
---|
| 243 | # we only need to add datechunk - 1 days to retrieval |
---|
| 244 | # for a period |
---|
[ca867de] | 245 | delta_t_m1 = delta_t - timedelta(days=1) |
---|
[54a8a01] | 246 | |
---|
[efdb01a] | 247 | day = start |
---|
| 248 | while day <= end: |
---|
[54a8a01] | 249 | flexpart = EcFlexpart(c, fluxes) |
---|
| 250 | tmpday = day + delta_t_m1 |
---|
[ff99eae] | 251 | if tmpday < end: |
---|
| 252 | dates = day.strftime("%Y%m%d") + "/to/" + \ |
---|
| 253 | tmpday.strftime("%Y%m%d") |
---|
| 254 | else: |
---|
| 255 | dates = day.strftime("%Y%m%d") + "/to/" + \ |
---|
| 256 | end.strftime("%Y%m%d") |
---|
[efdb01a] | 257 | |
---|
[2fb99de] | 258 | print("... retrieve " + dates + " in dir " + c.inputdir) |
---|
[64cf353] | 259 | |
---|
[ff99eae] | 260 | try: |
---|
[5bad6ec] | 261 | flexpart.retrieve(server, dates, c.public, c.request, c.inputdir) |
---|
[ff99eae] | 262 | except IOError: |
---|
[54a8a01] | 263 | my_error(c.mailfail, 'MARS request failed') |
---|
[efdb01a] | 264 | |
---|
[54a8a01] | 265 | day += delta_t |
---|
[64cf353] | 266 | |
---|
[efdb01a] | 267 | return |
---|
[d69b677] | 268 | |
---|
| 269 | if __name__ == "__main__": |
---|
[991df6a] | 270 | main() |
---|