[8463d78] | 1 | #!/usr/bin/env python3 |
---|
[64cf353] | 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): |
---|
| 11 | # - job submission on ecgate and cca |
---|
| 12 | # - job templates suitable for twice daily operational dissemination |
---|
| 13 | # |
---|
| 14 | # February 2018 - Anne Philipp (University of Vienna): |
---|
| 15 | # - applied PEP8 style guide |
---|
| 16 | # - added documentation |
---|
| 17 | # - minor changes in programming style (for consistence) |
---|
[2fb99de] | 18 | # - changed path names to variables from config file |
---|
| 19 | # - added option for writing mars requests to extra file |
---|
[6f951ca] | 20 | # additionally, as option without submitting the mars jobs |
---|
| 21 | # - splitted submit function to use genshi templates for the |
---|
| 22 | # job script and avoid code duplication |
---|
[991df6a] | 23 | # |
---|
| 24 | # @License: |
---|
[6f951ca] | 25 | # (C) Copyright 2014-2019. |
---|
| 26 | # Anne Philipp, Leopold Haimberger |
---|
[991df6a] | 27 | # |
---|
[44174de] | 28 | # SPDX-License-Identifier: CC-BY-4.0 |
---|
| 29 | # |
---|
[6f951ca] | 30 | # This work is licensed under the Creative Commons Attribution 4.0 |
---|
| 31 | # International License. To view a copy of this license, visit |
---|
| 32 | # http://creativecommons.org/licenses/by/4.0/ or send a letter to |
---|
| 33 | # Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. |
---|
[991df6a] | 34 | #******************************************************************************* |
---|
[6f951ca] | 35 | '''This script allows the user to extract meteorological fields from the ECMWF. |
---|
| 36 | |
---|
| 37 | It prepares the settings for retrieving the data from ECMWF servers and |
---|
| 38 | process the resulting files to prepare them for the use with FLEXPART or |
---|
| 39 | FLEXTRA. |
---|
| 40 | |
---|
| 41 | If it is supposed to work locally then it works through the necessary |
---|
| 42 | functions get_mars_data and prepare_flexpart. Otherwise it prepares |
---|
| 43 | a job script (korn shell) which will do the necessary work on the |
---|
| 44 | ECMWF server. This script will de submitted via the ecaccess command |
---|
| 45 | ecaccess-job-submit. |
---|
| 46 | |
---|
| 47 | This file can also be imported as a module which then contains the following |
---|
| 48 | functions: |
---|
| 49 | |
---|
| 50 | * main - the main function of the script |
---|
| 51 | * submit - calls mk_jobscript depending on operation mode and submits its |
---|
| 52 | * mk_jobscript - creates the job script from a template |
---|
| 53 | |
---|
| 54 | Type: submit.py --help |
---|
| 55 | to get information about command line parameters. |
---|
| 56 | Read the documentation for usage instructions. |
---|
| 57 | ''' |
---|
[efdb01a] | 58 | |
---|
[64cf353] | 59 | # ------------------------------------------------------------------------------ |
---|
| 60 | # MODULES |
---|
| 61 | # ------------------------------------------------------------------------------ |
---|
[a1011e7] | 62 | from __future__ import print_function |
---|
| 63 | |
---|
[efdb01a] | 64 | import os |
---|
| 65 | import sys |
---|
[d69b677] | 66 | import subprocess |
---|
| 67 | import inspect |
---|
[54a8a01] | 68 | import collections |
---|
[f2616a3] | 69 | from datetime import datetime, timedelta |
---|
[efdb01a] | 70 | |
---|
| 71 | # software specific classes and modules from flex_extract |
---|
[54a8a01] | 72 | import _config |
---|
[ba99230] | 73 | from Mods.tools import (setup_controldata, normal_exit, get_cmdline_args, |
---|
[79729d5] | 74 | submit_job_to_ecserver, read_ecenv) |
---|
[ba99230] | 75 | from Mods.get_mars_data import get_mars_data |
---|
| 76 | from Mods.prepare_flexpart import prepare_flexpart |
---|
| 77 | from Classes.ControlFile import ControlFile |
---|
[991df6a] | 78 | |
---|
[d727af2] | 79 | |
---|
[64cf353] | 80 | # ------------------------------------------------------------------------------ |
---|
[6f951ca] | 81 | # METHODS |
---|
[64cf353] | 82 | # ------------------------------------------------------------------------------ |
---|
[991df6a] | 83 | |
---|
[d69b677] | 84 | def main(): |
---|
[274f9ef] | 85 | '''Get the arguments from script call and from CONTROL file. |
---|
| 86 | Decides from the argument "queue" if the local version |
---|
| 87 | is done "queue=None" or the gateway version with "queue=ecgate" |
---|
| 88 | or "queue=cca". |
---|
| 89 | |
---|
| 90 | Parameters |
---|
| 91 | ---------- |
---|
[d69b677] | 92 | |
---|
[d727af2] | 93 | |
---|
[274f9ef] | 94 | Return |
---|
| 95 | ------ |
---|
[64cf353] | 96 | |
---|
| 97 | ''' |
---|
[ff99eae] | 98 | |
---|
[f20af73] | 99 | c, ppid, queue, job_template = setup_controldata() |
---|
[ff99eae] | 100 | |
---|
[efdb01a] | 101 | # on local side |
---|
[f20af73] | 102 | # starting from an ECMWF server this would also be the local side |
---|
[2fb99de] | 103 | called_from_dir = os.getcwd() |
---|
[f20af73] | 104 | if queue is None: |
---|
[64cf353] | 105 | if c.inputdir[0] != '/': |
---|
[ff99eae] | 106 | c.inputdir = os.path.join(called_from_dir, c.inputdir) |
---|
[64cf353] | 107 | if c.outputdir[0] != '/': |
---|
[ff99eae] | 108 | c.outputdir = os.path.join(called_from_dir, c.outputdir) |
---|
[54a8a01] | 109 | get_mars_data(c) |
---|
[2fb99de] | 110 | if c.request == 0 or c.request == 2: |
---|
[f20af73] | 111 | prepare_flexpart(ppid, c) |
---|
[96e1533] | 112 | exit_message = 'FLEX_EXTRACT IS DONE!' |
---|
[2fb99de] | 113 | else: |
---|
[96e1533] | 114 | exit_message = 'PRINTING MARS_REQUESTS DONE!' |
---|
| 115 | # send files to ECMWF server |
---|
[d69b677] | 116 | else: |
---|
[f20af73] | 117 | submit(job_template, c, queue) |
---|
[e0e99a5] | 118 | exit_message = 'FLEX_EXTRACT JOB SCRIPT IS SUBMITED!' |
---|
[64cf353] | 119 | |
---|
[403cbf1] | 120 | normal_exit(exit_message) |
---|
[96e1533] | 121 | |
---|
[64cf353] | 122 | return |
---|
| 123 | |
---|
| 124 | def submit(jtemplate, c, queue): |
---|
[ff2a11c] | 125 | '''Prepares the job script and submits it to the specified queue. |
---|
[274f9ef] | 126 | |
---|
| 127 | Parameters |
---|
| 128 | ---------- |
---|
[6f951ca] | 129 | jtemplate : str |
---|
[274f9ef] | 130 | Job template file from sub-directory "_templates" for |
---|
| 131 | submission to ECMWF. It contains all necessary |
---|
| 132 | module and variable settings for the ECMWF environment as well as |
---|
| 133 | the job call and mail report instructions. |
---|
| 134 | Default is "job.temp". |
---|
| 135 | |
---|
[6f951ca] | 136 | c : ControlFile |
---|
[274f9ef] | 137 | Contains all the parameters of CONTROL file and |
---|
| 138 | command line. |
---|
| 139 | |
---|
[6f951ca] | 140 | queue : str |
---|
[274f9ef] | 141 | Name of queue for submission to ECMWF (e.g. ecgate or cca ) |
---|
| 142 | |
---|
| 143 | Return |
---|
| 144 | ------ |
---|
| 145 | |
---|
[64cf353] | 146 | ''' |
---|
| 147 | |
---|
[d4696e0] | 148 | if not c.oper: |
---|
[54a8a01] | 149 | # --------- create on demand job script ------------------------------------ |
---|
[a4531f1] | 150 | if c.purefc: |
---|
[2fb99de] | 151 | print('---- Pure forecast mode! ----') |
---|
[54a8a01] | 152 | else: |
---|
[2fb99de] | 153 | print('---- On-demand mode! ----') |
---|
[54a8a01] | 154 | |
---|
[ff2a11c] | 155 | job_file = os.path.join(_config.PATH_JOBSCRIPTS, |
---|
| 156 | jtemplate[:-5] + '.ksh') |
---|
[54a8a01] | 157 | |
---|
[f2616a3] | 158 | # divide time periode into specified number of job chunks |
---|
| 159 | # to have multiple job scripts |
---|
| 160 | if c.job_chunk: |
---|
| 161 | start = datetime.strptime(c.start_date, '%Y%m%d') |
---|
| 162 | end = datetime.strptime(c.end_date, '%Y%m%d') |
---|
| 163 | chunk = timedelta(days=c.job_chunk) |
---|
[fc05fbd] | 164 | oneday = timedelta(days=1) |
---|
[54a8a01] | 165 | |
---|
[f2616a3] | 166 | while start <= end: |
---|
| 167 | if (start + chunk) <= end: |
---|
[fc05fbd] | 168 | c.end_date = (start + chunk - oneday).strftime("%Y%m%d") |
---|
[f2616a3] | 169 | else: |
---|
| 170 | c.end_date = end.strftime("%Y%m%d") |
---|
| 171 | |
---|
| 172 | clist = c.to_list() |
---|
| 173 | mk_jobscript(jtemplate, job_file, clist) |
---|
| 174 | |
---|
| 175 | job_id = submit_job_to_ecserver(queue, job_file) |
---|
| 176 | print('The job id is: ' + str(job_id.strip())) |
---|
| 177 | |
---|
| 178 | start = start + chunk |
---|
| 179 | c.start_date = start.strftime("%Y%m%d") |
---|
| 180 | # submit a single job script |
---|
| 181 | else: |
---|
| 182 | clist = c.to_list() |
---|
| 183 | |
---|
| 184 | mk_jobscript(jtemplate, job_file, clist) |
---|
| 185 | |
---|
| 186 | job_id = submit_job_to_ecserver(queue, job_file) |
---|
| 187 | print('The job id is: ' + str(job_id.strip())) |
---|
[54a8a01] | 188 | |
---|
| 189 | else: |
---|
| 190 | # --------- create operational job script ---------------------------------- |
---|
[2fb99de] | 191 | print('---- Operational mode! ----') |
---|
[ff2a11c] | 192 | |
---|
[2fb99de] | 193 | job_file = os.path.join(_config.PATH_JOBSCRIPTS, |
---|
| 194 | jtemplate[:-5] + 'oper.ksh') |
---|
[54a8a01] | 195 | |
---|
| 196 | c.start_date = '${MSJ_YEAR}${MSJ_MONTH}${MSJ_DAY}' |
---|
| 197 | c.end_date = '${MSJ_YEAR}${MSJ_MONTH}${MSJ_DAY}' |
---|
[d4696e0] | 198 | c.basetime = '${MSJ_BASETIME}' |
---|
[ff2a11c] | 199 | if c.maxstep > 24: |
---|
[54a8a01] | 200 | c.time = '${MSJ_BASETIME} {MSJ_BASETIME}' |
---|
| 201 | |
---|
[ff2a11c] | 202 | clist = c.to_list() |
---|
[54a8a01] | 203 | |
---|
[ff2a11c] | 204 | mk_jobscript(jtemplate, job_file, clist) |
---|
[d69b677] | 205 | |
---|
[f2616a3] | 206 | job_id = submit_job_to_ecserver(queue, job_file) |
---|
| 207 | print('The job id is: ' + str(job_id.strip())) |
---|
| 208 | |
---|
| 209 | print('You should get an email per job with subject flex.hostname.pid') |
---|
[d69b677] | 210 | |
---|
[64cf353] | 211 | return |
---|
[d69b677] | 212 | |
---|
[ff2a11c] | 213 | def mk_jobscript(jtemplate, job_file, clist): |
---|
| 214 | '''Creates the job script from template. |
---|
| 215 | |
---|
| 216 | Parameters |
---|
| 217 | ---------- |
---|
[6f951ca] | 218 | jtemplate : str |
---|
[ff2a11c] | 219 | Job template file from sub-directory "_templates" for |
---|
| 220 | submission to ECMWF. It contains all necessary |
---|
| 221 | module and variable settings for the ECMWF environment as well as |
---|
| 222 | the job call and mail report instructions. |
---|
| 223 | Default is "job.temp". |
---|
| 224 | |
---|
[6f951ca] | 225 | job_file : str |
---|
[ff2a11c] | 226 | Path to the job script file. |
---|
| 227 | |
---|
[6f951ca] | 228 | clist : list of str |
---|
[ff2a11c] | 229 | Contains all necessary parameters for ECMWF CONTROL file. |
---|
| 230 | |
---|
| 231 | Return |
---|
| 232 | ------ |
---|
| 233 | |
---|
| 234 | ''' |
---|
| 235 | from genshi.template.text import NewTextTemplate |
---|
| 236 | from genshi.template import TemplateLoader |
---|
| 237 | from genshi.template.eval import UndefinedError |
---|
| 238 | |
---|
| 239 | # load template and insert control content as list |
---|
| 240 | try: |
---|
| 241 | loader = TemplateLoader(_config.PATH_TEMPLATES, auto_reload=False) |
---|
| 242 | control_template = loader.load(jtemplate, |
---|
| 243 | cls=NewTextTemplate) |
---|
| 244 | |
---|
| 245 | stream = control_template.generate(control_content=clist) |
---|
| 246 | except UndefinedError as e: |
---|
| 247 | print('... ERROR ' + str(e)) |
---|
| 248 | |
---|
| 249 | sys.exit('\n... error occured while trying to generate jobscript') |
---|
| 250 | except OSError as e: |
---|
| 251 | print('... ERROR CODE: ' + str(e.errno)) |
---|
| 252 | print('... ERROR MESSAGE:\n \t ' + str(e.strerror)) |
---|
| 253 | |
---|
| 254 | sys.exit('\n... error occured while trying to generate jobscript') |
---|
| 255 | |
---|
| 256 | # create jobscript file |
---|
| 257 | try: |
---|
| 258 | with open(job_file, 'w') as f: |
---|
| 259 | f.write(stream.render('text')) |
---|
| 260 | except OSError as e: |
---|
| 261 | print('... ERROR CODE: ' + str(e.errno)) |
---|
| 262 | print('... ERROR MESSAGE:\n \t ' + str(e.strerror)) |
---|
| 263 | |
---|
| 264 | sys.exit('\n... error occured while trying to write ' + job_file) |
---|
| 265 | |
---|
| 266 | return |
---|
| 267 | |
---|
[f2616a3] | 268 | |
---|
[d69b677] | 269 | if __name__ == "__main__": |
---|
| 270 | main() |
---|