[d69b677] | 1 | #!/usr/bin/env python |
---|
[64cf353] | 2 | # -*- coding: utf-8 -*- |
---|
[991df6a] | 3 | #******************************************************************************* |
---|
| 4 | # @Author: Leopold Haimberger (University of Vienna) |
---|
| 5 | # |
---|
| 6 | # @Date: November 2015 |
---|
| 7 | # |
---|
| 8 | # @Change History: |
---|
| 9 | # |
---|
| 10 | # February 2018 - Anne Philipp (University of Vienna): |
---|
| 11 | # - applied PEP8 style guide |
---|
| 12 | # - added documentation |
---|
[ff99eae] | 13 | # - moved install_args_and_control in here |
---|
[2fb99de] | 14 | # - splitted code in smaller functions |
---|
| 15 | # - delete convert build files in here instead of compile job script |
---|
| 16 | # - changed static path names to Variables from config file |
---|
[991df6a] | 17 | # |
---|
| 18 | # @License: |
---|
| 19 | # (C) Copyright 2015-2018. |
---|
| 20 | # |
---|
| 21 | # This software is licensed under the terms of the Apache Licence Version 2.0 |
---|
| 22 | # which can be obtained at http://www.apache.org/licenses/LICENSE-2.0. |
---|
| 23 | # |
---|
| 24 | # @Program Functionality: |
---|
| 25 | # Depending on the selected installation environment (locally or on the |
---|
| 26 | # ECMWF server ecgate or cca) the program extracts the commandline |
---|
| 27 | # arguments and the CONTROL file parameter and prepares the corresponding |
---|
| 28 | # environment. The necessary files are collected in a tar-ball and placed |
---|
| 29 | # at the target location. There its untared, the environment variables will |
---|
| 30 | # be set and the Fortran code will be compiled. If the ECMWF environment is |
---|
| 31 | # selected a job script is prepared and submitted for the remaining |
---|
| 32 | # configurations after putting the tar-ball to the target ECMWF server. |
---|
| 33 | # |
---|
| 34 | # @Program Content: |
---|
| 35 | # - main |
---|
[54a8a01] | 36 | # - get_install_cmdline_arguments |
---|
[991df6a] | 37 | # - install_via_gateway |
---|
[54a8a01] | 38 | # - mk_tarball |
---|
[2fb99de] | 39 | # - un_tarball |
---|
[54a8a01] | 40 | # - mk_env_vars |
---|
| 41 | # - mk_compilejob |
---|
| 42 | # - mk_job_template |
---|
| 43 | # - delete_convert_build |
---|
| 44 | # - make_convert_build |
---|
[991df6a] | 45 | # |
---|
| 46 | #******************************************************************************* |
---|
| 47 | |
---|
[64cf353] | 48 | # ------------------------------------------------------------------------------ |
---|
| 49 | # MODULES |
---|
| 50 | # ------------------------------------------------------------------------------ |
---|
[991df6a] | 51 | import os |
---|
| 52 | import sys |
---|
[2fb99de] | 53 | import glob |
---|
[d69b677] | 54 | import subprocess |
---|
| 55 | import inspect |
---|
[ff99eae] | 56 | from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter |
---|
[991df6a] | 57 | |
---|
| 58 | # software specific classes and modules from flex_extract |
---|
[2fb99de] | 59 | import _config |
---|
[25b14be] | 60 | from classes.ControlFile import ControlFile |
---|
| 61 | from classes.UioFiles import UioFiles |
---|
| 62 | from mods.tools import make_dir, put_file_to_ecserver, submit_job_to_ecserver |
---|
[d69b677] | 63 | |
---|
[64cf353] | 64 | # ------------------------------------------------------------------------------ |
---|
| 65 | # FUNCTIONS |
---|
| 66 | # ------------------------------------------------------------------------------ |
---|
[991df6a] | 67 | def main(): |
---|
| 68 | ''' |
---|
| 69 | @Description: |
---|
| 70 | Controls the installation process. Calls the installation function |
---|
| 71 | if target is specified. |
---|
| 72 | |
---|
| 73 | @Intput: |
---|
| 74 | <nothing> |
---|
| 75 | |
---|
| 76 | @Return: |
---|
| 77 | <nothing> |
---|
| 78 | ''' |
---|
| 79 | |
---|
[54a8a01] | 80 | args = get_install_cmdline_arguments() |
---|
[4971f63] | 81 | c = ControlFile(args.controlfile) |
---|
[54a8a01] | 82 | c.assign_args_to_control(args) |
---|
| 83 | c.check_install_conditions() |
---|
[991df6a] | 84 | |
---|
[54a8a01] | 85 | install_via_gateway(c) |
---|
[991df6a] | 86 | |
---|
[54a8a01] | 87 | return |
---|
[991df6a] | 88 | |
---|
[54a8a01] | 89 | def get_install_cmdline_arguments(): |
---|
[efdb01a] | 90 | ''' |
---|
| 91 | @Description: |
---|
[54a8a01] | 92 | Decomposes the command line arguments and assigns them to variables. |
---|
| 93 | Apply default values for non mentioned arguments. |
---|
[efdb01a] | 94 | |
---|
| 95 | @Input: |
---|
| 96 | <nothing> |
---|
| 97 | |
---|
| 98 | @Return: |
---|
| 99 | args: instance of ArgumentParser |
---|
| 100 | Contains the commandline arguments from script/program call. |
---|
| 101 | ''' |
---|
[54a8a01] | 102 | parser = ArgumentParser(description='Install flex_extract software locally or \ |
---|
[efdb01a] | 103 | on ECMWF machines', |
---|
| 104 | formatter_class=ArgumentDefaultsHelpFormatter) |
---|
| 105 | |
---|
[54a8a01] | 106 | parser.add_argument('--target', dest='install_target', default=None, |
---|
[efdb01a] | 107 | help="Valid targets: local | ecgate | cca , \ |
---|
| 108 | the latter two are at ECMWF") |
---|
[54a8a01] | 109 | parser.add_argument("--makefile", dest="makefile", default=None, |
---|
[efdb01a] | 110 | help='Name of Makefile to use for compiling CONVERT2') |
---|
[54a8a01] | 111 | parser.add_argument("--ecuid", dest="ecuid", default=None, |
---|
[efdb01a] | 112 | help='user id at ECMWF') |
---|
[54a8a01] | 113 | parser.add_argument("--ecgid", dest="ecgid", default=None, |
---|
[efdb01a] | 114 | help='group id at ECMWF') |
---|
[54a8a01] | 115 | parser.add_argument("--gateway", dest="gateway", default=None, |
---|
[efdb01a] | 116 | help='name of local gateway server') |
---|
[54a8a01] | 117 | parser.add_argument("--destination", dest="destination", default=None, |
---|
[efdb01a] | 118 | help='ecaccess destination, e.g. leo@genericSftp') |
---|
| 119 | |
---|
| 120 | parser.add_argument("--flexpart_root_scripts", dest="flexpart_root_scripts", |
---|
[54a8a01] | 121 | default=None, help="FLEXPART root directory on ECMWF \ |
---|
| 122 | servers (to find grib2flexpart and COMMAND file)\n\ |
---|
| 123 | Normally flex_extract resides in the scripts directory \ |
---|
[2fb99de] | 124 | of the FLEXPART distribution.") |
---|
[efdb01a] | 125 | |
---|
[54a8a01] | 126 | # arguments for job submission to ECMWF, only needed by submit.py |
---|
[efdb01a] | 127 | parser.add_argument("--job_template", dest='job_template', |
---|
| 128 | default="job.temp.o", |
---|
| 129 | help="job template file for submission to ECMWF") |
---|
| 130 | |
---|
| 131 | parser.add_argument("--controlfile", dest="controlfile", |
---|
| 132 | default='CONTROL.temp', |
---|
[991df6a] | 133 | help="file with CONTROL parameters") |
---|
[efdb01a] | 134 | |
---|
| 135 | args = parser.parse_args() |
---|
| 136 | |
---|
[54a8a01] | 137 | return args |
---|
| 138 | |
---|
[efdb01a] | 139 | |
---|
[54a8a01] | 140 | def install_via_gateway(c): |
---|
[a4b6cef] | 141 | ''' |
---|
[991df6a] | 142 | @Description: |
---|
| 143 | Perform the actual installation on local machine or prepare data |
---|
| 144 | transfer to remote gate and submit a job script which will |
---|
| 145 | install everything on the remote gate. |
---|
[a4b6cef] | 146 | |
---|
[991df6a] | 147 | @Input: |
---|
| 148 | c: instance of class ControlFile |
---|
| 149 | Contains all necessary information of a CONTROL file. The parameters |
---|
| 150 | are: DAY1, DAY2, DTIME, MAXSTEP, TYPE, TIME, STEP, CLASS, STREAM, |
---|
| 151 | NUMBER, EXPVER, GRID, LEFT, LOWER, UPPER, RIGHT, LEVEL, LEVELIST, |
---|
| 152 | RESOL, GAUSS, ACCURACY, OMEGA, OMEGADIFF, ETA, ETADIFF, DPDETA, |
---|
| 153 | SMOOTH, FORMAT, ADDPAR, WRF, CWC, PREFIX, ECSTORAGE, ECTRANS, |
---|
| 154 | ECFSDIR, MAILOPS, MAILFAIL, GRIB2FLEXPART, FLEXPARTDIR |
---|
| 155 | For more information about format and content of the parameter see |
---|
| 156 | documentation. |
---|
| 157 | |
---|
[54a8a01] | 158 | @Return: |
---|
| 159 | <nothing> |
---|
| 160 | ''' |
---|
[2fb99de] | 161 | import tarfile |
---|
| 162 | |
---|
| 163 | ecd = _config.PATH_FLEXEXTRACT_DIR |
---|
| 164 | tarball_name = _config.FLEXEXTRACT_DIRNAME + '.tar' |
---|
| 165 | tar_file = os.path.join(ecd, tarball_name) |
---|
[54a8a01] | 166 | |
---|
[2fb99de] | 167 | target_dirname = _config.FLEXEXTRACT_DIRNAME |
---|
| 168 | fortran_executable = _config.FORTRAN_EXECUTABLE |
---|
[54a8a01] | 169 | |
---|
[97e09f4] | 170 | if c.install_target.lower() != 'local': # ecgate or cca |
---|
[54a8a01] | 171 | |
---|
[2fb99de] | 172 | mk_compilejob(c.makefile, c.install_target, c.ecuid, c.ecgid, |
---|
[54a8a01] | 173 | c.flexpart_root_scripts) |
---|
| 174 | |
---|
[2fb99de] | 175 | mk_job_template(c.ecuid, c.ecgid, c.gateway, |
---|
[54a8a01] | 176 | c.destination, c.flexpart_root_scripts) |
---|
| 177 | |
---|
[2fb99de] | 178 | mk_env_vars(c.ecuid, c.ecgid, c.gateway, c.destination) |
---|
[54a8a01] | 179 | |
---|
[25b14be] | 180 | mk_tarball(tar_file, c.install_target) |
---|
[54a8a01] | 181 | |
---|
| 182 | put_file_to_ecserver(ecd, tarball_name, c.install_target, |
---|
| 183 | c.ecuid, c.ecgid) |
---|
| 184 | |
---|
[2fb99de] | 185 | submit_job_to_ecserver(c.install_target, |
---|
[25b14be] | 186 | os.path.join(_config.PATH_REL_JOBSCRIPTS, |
---|
[2fb99de] | 187 | _config.FILE_INSTALL_COMPILEJOB)) |
---|
[54a8a01] | 188 | |
---|
[2fb99de] | 189 | print('job compilation script has been submitted to ecgate for ' + |
---|
| 190 | 'installation in ' + c.flexpart_root_scripts + |
---|
| 191 | '/' + target_dirname) |
---|
| 192 | print('You should get an email with subject "flexcompile" within ' + |
---|
| 193 | 'the next few minutes!') |
---|
[54a8a01] | 194 | |
---|
| 195 | else: #local |
---|
[2fb99de] | 196 | if c.flexpart_root_scripts == _config.PATH_FLEXEXTRACT_DIR : |
---|
| 197 | print('WARNING: FLEXPART_ROOT_SCRIPTS has not been specified') |
---|
| 198 | print('flex_extract will be installed in here by compiling the ' + |
---|
| 199 | 'Fortran source in ' + _config.PATH_FORTRAN_SRC) |
---|
| 200 | os.chdir(_config.PATH_FORTRAN_SRC) |
---|
[54a8a01] | 201 | else: # creates the target working directory for flex_extract |
---|
| 202 | c.flexpart_root_scripts = os.path.expandvars(os.path.expanduser( |
---|
[2fb99de] | 203 | c.flexpart_root_scripts)) |
---|
[54a8a01] | 204 | if os.path.abspath(ecd) != os.path.abspath(c.flexpart_root_scripts): |
---|
[25b14be] | 205 | mk_tarball(tar_file, c.install_target) |
---|
[2fb99de] | 206 | make_dir(os.path.join(c.flexpart_root_scripts, |
---|
| 207 | target_dirname)) |
---|
| 208 | os.chdir(os.path.join(c.flexpart_root_scripts, |
---|
| 209 | target_dirname)) |
---|
| 210 | un_tarball(tar_file) |
---|
| 211 | os.chdir(os.path.join(c.flexpart_root_scripts, |
---|
| 212 | target_dirname, |
---|
[25b14be] | 213 | _config.PATH_REL_FORTRAN_SRC)) |
---|
[54a8a01] | 214 | |
---|
| 215 | # Create Fortran executable - CONVERT2 |
---|
[2fb99de] | 216 | print('Install ' + target_dirname + ' software at ' + |
---|
| 217 | c.install_target + ' in directory ' + |
---|
| 218 | os.path.abspath(c.flexpart_root_scripts) + '\n') |
---|
| 219 | |
---|
| 220 | delete_convert_build('.') |
---|
| 221 | make_convert_build('.', c.makefile) |
---|
[54a8a01] | 222 | |
---|
[2fb99de] | 223 | os.chdir(ecd) |
---|
| 224 | if os.path.isfile(tar_file): |
---|
| 225 | os.remove(tar_file) |
---|
[54a8a01] | 226 | |
---|
| 227 | return |
---|
| 228 | |
---|
[25b14be] | 229 | def mk_tarball(tarball_path, target): |
---|
[54a8a01] | 230 | ''' |
---|
| 231 | @Description: |
---|
[2fb99de] | 232 | Creates a tarball with all necessary files which need to be sent to the |
---|
[54a8a01] | 233 | installation directory. |
---|
| 234 | It does not matter if this is local or remote. |
---|
| 235 | Collects all python files, the Fortran source and makefiles, |
---|
[2fb99de] | 236 | the ECMWF_ENV file, the CONTROL files as well as the |
---|
| 237 | template files. |
---|
[54a8a01] | 238 | |
---|
| 239 | @Input: |
---|
[2fb99de] | 240 | tarball_path: string |
---|
| 241 | The complete path to the tar file which will contain all |
---|
| 242 | relevant data for flex_extract. |
---|
[54a8a01] | 243 | |
---|
[25b14be] | 244 | target: string |
---|
| 245 | The queue where the job is submitted to. |
---|
| 246 | |
---|
[54a8a01] | 247 | @Return: |
---|
| 248 | <nothing> |
---|
| 249 | ''' |
---|
[2fb99de] | 250 | import tarfile |
---|
| 251 | from glob import glob |
---|
| 252 | |
---|
| 253 | print('Create tarball ...') |
---|
| 254 | |
---|
| 255 | # change to FLEXEXTRACT directory so that the tar can contain |
---|
| 256 | # relative pathes to the files and directories |
---|
| 257 | ecd = _config.PATH_FLEXEXTRACT_DIR + '/' |
---|
| 258 | os.chdir(ecd) |
---|
| 259 | |
---|
| 260 | # get lists of the files to be added to the tar file |
---|
[25b14be] | 261 | if target == 'local': |
---|
| 262 | ECMWF_ENV_FILE = [] |
---|
| 263 | else: |
---|
| 264 | ECMWF_ENV_FILE = [_config.PATH_REL_ECMWF_ENV] |
---|
| 265 | |
---|
[2fb99de] | 266 | pyfiles = [os.path.relpath(x, ecd) |
---|
[25b14be] | 267 | for x in UioFiles(_config.PATH_LOCAL_PYTHON, '*py').files] |
---|
[2fb99de] | 268 | controlfiles = [os.path.relpath(x, ecd) |
---|
[25b14be] | 269 | for x in UioFiles(_config.PATH_CONTROLFILES, |
---|
| 270 | 'CONTROL*').files] |
---|
[2fb99de] | 271 | tempfiles = [os.path.relpath(x, ecd) |
---|
[25b14be] | 272 | for x in UioFiles(_config.PATH_TEMPLATES , '*').files] |
---|
[2fb99de] | 273 | ffiles = [os.path.relpath(x, ecd) |
---|
[25b14be] | 274 | for x in UioFiles(_config.PATH_FORTRAN_SRC, '*.f*').files] |
---|
[2fb99de] | 275 | hfiles = [os.path.relpath(x, ecd) |
---|
[25b14be] | 276 | for x in UioFiles(_config.PATH_FORTRAN_SRC, '*.h').files] |
---|
[2fb99de] | 277 | makefiles = [os.path.relpath(x, ecd) |
---|
[25b14be] | 278 | for x in UioFiles(_config.PATH_FORTRAN_SRC, 'Makefile*').files] |
---|
[2fb99de] | 279 | |
---|
| 280 | # concatenate single lists to one for a better looping |
---|
| 281 | filelist = pyfiles + controlfiles + tempfiles + ffiles + hfiles + \ |
---|
| 282 | makefiles + ECMWF_ENV_FILE |
---|
| 283 | |
---|
| 284 | # create installation tar-file |
---|
[54a8a01] | 285 | try: |
---|
[2fb99de] | 286 | with tarfile.open(tarball_path, "w:gz") as tar_handle: |
---|
| 287 | for file in filelist: |
---|
| 288 | tar_handle.add(file) |
---|
| 289 | |
---|
[54a8a01] | 290 | except subprocess.CalledProcessError as e: |
---|
[2fb99de] | 291 | print('... ERROR CODE:\n ... ' + str(e.returncode)) |
---|
| 292 | print('... ERROR MESSAGE:\n ... ' + str(e)) |
---|
| 293 | |
---|
| 294 | sys.exit('... could not make installation tar ball!') |
---|
[54a8a01] | 295 | |
---|
| 296 | return |
---|
| 297 | |
---|
[2fb99de] | 298 | |
---|
| 299 | def un_tarball(tarball_path): |
---|
| 300 | ''' |
---|
| 301 | @Description: |
---|
| 302 | Extracts the given tarball into current directory. |
---|
| 303 | |
---|
| 304 | @Input: |
---|
| 305 | tarball_path: string |
---|
| 306 | The complete path to the tar file which will contain all |
---|
| 307 | relevant data for flex_extract. |
---|
| 308 | |
---|
| 309 | @Return: |
---|
| 310 | <nothing> |
---|
| 311 | ''' |
---|
| 312 | import tarfile |
---|
| 313 | |
---|
| 314 | print('Untar ...') |
---|
| 315 | |
---|
| 316 | with tarfile.open(tarball_path) as tar_handle: |
---|
| 317 | tar_handle.extractall() |
---|
| 318 | |
---|
| 319 | return |
---|
| 320 | |
---|
| 321 | def mk_env_vars(ecuid, ecgid, gateway, destination): |
---|
[54a8a01] | 322 | ''' |
---|
| 323 | @Description: |
---|
| 324 | Creates a file named ECMWF_ENV which contains the |
---|
| 325 | necessary environmental variables at ECMWF servers. |
---|
| 326 | |
---|
| 327 | @Input: |
---|
| 328 | ecuid: string |
---|
| 329 | The user id on ECMWF server. |
---|
| 330 | |
---|
| 331 | ecgid: string |
---|
| 332 | The group id on ECMWF server. |
---|
| 333 | |
---|
| 334 | gateway: string |
---|
| 335 | The gateway server the user is using. |
---|
| 336 | |
---|
| 337 | destination: string |
---|
| 338 | The remote destination which is used to transfer files |
---|
| 339 | from ECMWF server to local gateway server. |
---|
| 340 | |
---|
| 341 | @Return: |
---|
| 342 | <nothing> |
---|
| 343 | ''' |
---|
| 344 | |
---|
[25b14be] | 345 | with open(_config.PATH_REL_ECMWF_ENV, 'w') as fo: |
---|
[54a8a01] | 346 | fo.write('ECUID ' + ecuid + '\n') |
---|
| 347 | fo.write('ECGID ' + ecgid + '\n') |
---|
| 348 | fo.write('GATEWAY ' + gateway + '\n') |
---|
| 349 | fo.write('DESTINATION ' + destination + '\n') |
---|
| 350 | |
---|
| 351 | return |
---|
| 352 | |
---|
[2fb99de] | 353 | def mk_compilejob(makefile, target, ecuid, ecgid, fp_root): |
---|
[54a8a01] | 354 | ''' |
---|
| 355 | @Description: |
---|
| 356 | Modifies the original job template file so that it is specified |
---|
| 357 | for the user and the environment were it will be applied. Result |
---|
| 358 | is stored in a new file "job.temp" in the python directory. |
---|
| 359 | |
---|
| 360 | @Input: |
---|
| 361 | makefile: string |
---|
| 362 | Name of the makefile which should be used to compile FORTRAN |
---|
| 363 | CONVERT2 program. |
---|
| 364 | |
---|
[991df6a] | 365 | target: string |
---|
[54a8a01] | 366 | The target where the installation should be done, e.g. the queue. |
---|
| 367 | |
---|
| 368 | ecuid: string |
---|
| 369 | The user id on ECMWF server. |
---|
| 370 | |
---|
| 371 | ecgid: string |
---|
| 372 | The group id on ECMWF server. |
---|
| 373 | |
---|
| 374 | fp_root: string |
---|
| 375 | Path to the root directory of FLEXPART environment or flex_extract |
---|
| 376 | environment. |
---|
[a4b6cef] | 377 | |
---|
[991df6a] | 378 | @Return: |
---|
| 379 | <nothing> |
---|
| 380 | ''' |
---|
[54a8a01] | 381 | |
---|
[25b14be] | 382 | template = os.path.join(_config.PATH_REL_TEMPLATES, |
---|
[2fb99de] | 383 | _config.TEMPFILE_INSTALL_COMPILEJOB) |
---|
[d69b677] | 384 | with open(template) as f: |
---|
[a4b6cef] | 385 | fdata = f.read().split('\n') |
---|
[54a8a01] | 386 | |
---|
[25b14be] | 387 | compilejob = os.path.join(_config.PATH_REL_JOBSCRIPTS, |
---|
[2fb99de] | 388 | _config.FILE_INSTALL_COMPILEJOB) |
---|
| 389 | with open(compilejob, 'w') as fo: |
---|
[a4b6cef] | 390 | for data in fdata: |
---|
| 391 | if 'MAKEFILE=' in data: |
---|
[54a8a01] | 392 | data = 'export MAKEFILE=' + makefile |
---|
| 393 | elif 'FLEXPART_ROOT_SCRIPTS=' in data: |
---|
| 394 | if fp_root != '../': |
---|
| 395 | data = 'export FLEXPART_ROOT_SCRIPTS=' + fp_root |
---|
[a4b6cef] | 396 | else: |
---|
[ff99eae] | 397 | data = 'export FLEXPART_ROOT_SCRIPTS=$HOME' |
---|
[54a8a01] | 398 | elif target.lower() != 'local': |
---|
[a4b6cef] | 399 | if '--workdir' in data: |
---|
[54a8a01] | 400 | data = '#SBATCH --workdir=/scratch/ms/' + \ |
---|
| 401 | ecgid + '/' + ecuid |
---|
| 402 | elif '##PBS -o' in data: |
---|
| 403 | data = '##PBS -o /scratch/ms/' + ecgid + '/' + ecuid + \ |
---|
| 404 | 'flex_ecmwf.$Jobname.$Job_ID.out' |
---|
| 405 | elif 'FLEXPART_ROOT_SCRIPTS=' in data: |
---|
| 406 | if fp_root != '../': |
---|
| 407 | data = 'export FLEXPART_ROOT_SCRIPTS=' + fp_root |
---|
[a4b6cef] | 408 | else: |
---|
| 409 | data = 'export FLEXPART_ROOT_SCRIPTS=$HOME' |
---|
| 410 | fo.write(data + '\n') |
---|
[54a8a01] | 411 | |
---|
| 412 | return |
---|
| 413 | |
---|
[2fb99de] | 414 | def mk_job_template(ecuid, ecgid, gateway, destination, fp_root): |
---|
[54a8a01] | 415 | ''' |
---|
| 416 | @Description: |
---|
| 417 | Modifies the original job template file so that it is specified |
---|
| 418 | for the user and the environment were it will be applied. Result |
---|
[2fb99de] | 419 | is stored in a new file. |
---|
[54a8a01] | 420 | |
---|
| 421 | @Input: |
---|
| 422 | ecuid: string |
---|
| 423 | The user id on ECMWF server. |
---|
| 424 | |
---|
| 425 | ecgid: string |
---|
| 426 | The group id on ECMWF server. |
---|
| 427 | |
---|
| 428 | gateway: string |
---|
| 429 | The gateway server the user is using. |
---|
| 430 | |
---|
| 431 | destination: string |
---|
| 432 | The remote destination which is used to transfer files |
---|
| 433 | from ECMWF server to local gateway server. |
---|
| 434 | |
---|
| 435 | fp_root: string |
---|
| 436 | Path to the root directory of FLEXPART environment or flex_extract |
---|
| 437 | environment. |
---|
| 438 | |
---|
| 439 | @Return: |
---|
| 440 | <nothing> |
---|
| 441 | ''' |
---|
[2fb99de] | 442 | fp_root_path_to_python = os.path.join(fp_root, _config.FLEXEXTRACT_DIRNAME, |
---|
[25b14be] | 443 | _config.PATH_REL_PYTHON) |
---|
[54a8a01] | 444 | |
---|
[25b14be] | 445 | template = os.path.join(_config.PATH_REL_TEMPLATES, |
---|
[2fb99de] | 446 | _config.TEMPFILE_INSTALL_JOB) |
---|
[54a8a01] | 447 | with open(template) as f: |
---|
| 448 | fdata = f.read().split('\n') |
---|
| 449 | |
---|
[25b14be] | 450 | jobfile_temp = os.path.join(_config.PATH_REL_TEMPLATES, |
---|
[2fb99de] | 451 | _config.TEMPFILE_JOB) |
---|
| 452 | with open(jobfile_temp, 'w') as fo: |
---|
[a4b6cef] | 453 | for data in fdata: |
---|
| 454 | if '--workdir' in data: |
---|
[2fb99de] | 455 | data = '#SBATCH --workdir=/scratch/ms/' + ecgid + '/' + ecuid |
---|
[54a8a01] | 456 | elif '##PBS -o' in data: |
---|
| 457 | data = '##PBS -o /scratch/ms/' + ecgid + '/' + \ |
---|
| 458 | ecuid + 'flex_ecmwf.$Jobname.$Job_ID.out' |
---|
| 459 | elif 'export PATH=${PATH}:' in data: |
---|
[2fb99de] | 460 | data += fp_root_path_to_python |
---|
[a4b6cef] | 461 | |
---|
| 462 | fo.write(data + '\n') |
---|
[54a8a01] | 463 | return |
---|
| 464 | |
---|
[2fb99de] | 465 | def delete_convert_build(src_path): |
---|
[54a8a01] | 466 | ''' |
---|
| 467 | @Description: |
---|
| 468 | Clean up the Fortran source directory and remove all |
---|
| 469 | build files (e.g. *.o, *.mod and CONVERT2) |
---|
| 470 | |
---|
| 471 | @Input: |
---|
[2fb99de] | 472 | src_path: string |
---|
| 473 | Path to the fortran source directory. |
---|
[54a8a01] | 474 | |
---|
| 475 | @Return: |
---|
| 476 | <nothing> |
---|
| 477 | ''' |
---|
| 478 | |
---|
[2fb99de] | 479 | modfiles = UioFiles(src_path, '*.mod') |
---|
| 480 | objfiles = UioFiles(src_path, '*.o') |
---|
| 481 | exefile = UioFiles(src_path, _config.FORTRAN_EXECUTABLE) |
---|
[54a8a01] | 482 | |
---|
| 483 | modfiles.delete_files() |
---|
| 484 | objfiles.delete_files() |
---|
| 485 | exefile.delete_files() |
---|
| 486 | |
---|
| 487 | return |
---|
| 488 | |
---|
[2fb99de] | 489 | def make_convert_build(src_path, makefile): |
---|
[54a8a01] | 490 | ''' |
---|
| 491 | @Description: |
---|
| 492 | Compiles the Fortran code and generates the executable. |
---|
| 493 | |
---|
| 494 | @Input: |
---|
[2fb99de] | 495 | src_path: string |
---|
| 496 | Path to the fortran source directory. |
---|
[54a8a01] | 497 | |
---|
| 498 | makefile: string |
---|
| 499 | The name of the makefile which should be used. |
---|
| 500 | |
---|
| 501 | @Return: |
---|
| 502 | <nothing> |
---|
| 503 | ''' |
---|
| 504 | |
---|
| 505 | try: |
---|
[2fb99de] | 506 | print('Using makefile: ' + makefile) |
---|
| 507 | p = subprocess.Popen(['make', '-f', |
---|
| 508 | os.path.join(src_path, makefile)], |
---|
[54a8a01] | 509 | stdin=subprocess.PIPE, |
---|
| 510 | stdout=subprocess.PIPE, |
---|
| 511 | stderr=subprocess.PIPE, |
---|
| 512 | bufsize=1) |
---|
| 513 | pout, perr = p.communicate() |
---|
[2fb99de] | 514 | print(pout) |
---|
[54a8a01] | 515 | if p.returncode != 0: |
---|
[2fb99de] | 516 | print(perr) |
---|
| 517 | print('Please edit ' + makefile + |
---|
| 518 | ' or try another Makefile in the src directory.') |
---|
| 519 | print('Most likely GRIB_API_INCLUDE_DIR, GRIB_API_LIB ' |
---|
| 520 | 'and EMOSLIB must be adapted.') |
---|
| 521 | print('Available Makefiles:') |
---|
| 522 | print(UioFiles(src_path, 'Makefile*')) |
---|
[54a8a01] | 523 | sys.exit('Compilation failed!') |
---|
| 524 | except ValueError as e: |
---|
[2fb99de] | 525 | print('ERROR: Makefile call failed:') |
---|
| 526 | print(e) |
---|
[d69b677] | 527 | else: |
---|
[2fb99de] | 528 | subprocess.check_call(['ls', '-l', |
---|
| 529 | os.path.join(src_path, |
---|
| 530 | _config.FORTRAN_EXECUTABLE)]) |
---|
[a4b6cef] | 531 | |
---|
[d69b677] | 532 | return |
---|
| 533 | |
---|
[a4b6cef] | 534 | |
---|
[d69b677] | 535 | if __name__ == "__main__": |
---|
| 536 | main() |
---|