[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 |
---|
[6f951ca] | 16 | # - changed static path names to variables from config file |
---|
| 17 | # - splitted install function into several smaller pieces |
---|
| 18 | # - use of tarfile package in python |
---|
[991df6a] | 19 | # |
---|
| 20 | # @License: |
---|
[6f951ca] | 21 | # (C) Copyright 2014-2019. |
---|
| 22 | # Anne Philipp, Leopold Haimberger |
---|
[991df6a] | 23 | # |
---|
[6f951ca] | 24 | # This work is licensed under the Creative Commons Attribution 4.0 |
---|
| 25 | # International License. To view a copy of this license, visit |
---|
| 26 | # http://creativecommons.org/licenses/by/4.0/ or send a letter to |
---|
| 27 | # Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. |
---|
[991df6a] | 28 | # |
---|
[6f951ca] | 29 | # @Methods: |
---|
| 30 | # main |
---|
| 31 | # get_install_cmdline_args |
---|
| 32 | # install_via_gateway |
---|
| 33 | # check_install_conditions |
---|
| 34 | # mk_tarball |
---|
| 35 | # un_tarball |
---|
| 36 | # mk_env_vars |
---|
| 37 | # mk_compilejob |
---|
| 38 | # mk_job_template |
---|
| 39 | # del_convert_build |
---|
| 40 | # mk_convert_build |
---|
[991df6a] | 41 | # |
---|
| 42 | #******************************************************************************* |
---|
[6f951ca] | 43 | '''This script installs the flex_extract program. |
---|
| 44 | |
---|
| 45 | Depending on the selected installation environment (locally or on the |
---|
| 46 | ECMWF server ecgate or cca) the program extracts the commandline |
---|
| 47 | arguments and the CONTROL file parameter and prepares the corresponding |
---|
| 48 | environment. |
---|
| 49 | The necessary files are collected in a tar-ball and placed |
---|
| 50 | at the target location. There its untared, the environment variables will |
---|
| 51 | be set and the Fortran code will be compiled. |
---|
| 52 | If the ECMWF environment is selected a job script is prepared and submitted |
---|
| 53 | for the remaining configurations after putting the tar-ball to the |
---|
| 54 | target ECMWF server. |
---|
| 55 | |
---|
| 56 | Type: install.py --help |
---|
| 57 | to get information about command line parameters. |
---|
| 58 | Read the documentation for usage instructions. |
---|
| 59 | ''' |
---|
[991df6a] | 60 | |
---|
[64cf353] | 61 | # ------------------------------------------------------------------------------ |
---|
| 62 | # MODULES |
---|
| 63 | # ------------------------------------------------------------------------------ |
---|
[991df6a] | 64 | import os |
---|
| 65 | import sys |
---|
[2fb99de] | 66 | import glob |
---|
[d69b677] | 67 | import subprocess |
---|
| 68 | import inspect |
---|
[3946de5] | 69 | import tarfile |
---|
[ff99eae] | 70 | from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter |
---|
[991df6a] | 71 | |
---|
| 72 | # software specific classes and modules from flex_extract |
---|
[2fb99de] | 73 | import _config |
---|
[25b14be] | 74 | from classes.ControlFile import ControlFile |
---|
| 75 | from classes.UioFiles import UioFiles |
---|
[de4dc27] | 76 | from mods.tools import (make_dir, put_file_to_ecserver, submit_job_to_ecserver, |
---|
[bf48c8a] | 77 | silent_remove, execute_subprocess) |
---|
[d69b677] | 78 | |
---|
[64cf353] | 79 | # ------------------------------------------------------------------------------ |
---|
| 80 | # FUNCTIONS |
---|
| 81 | # ------------------------------------------------------------------------------ |
---|
[991df6a] | 82 | def main(): |
---|
[274f9ef] | 83 | '''Controls the installation process. Calls the installation function |
---|
| 84 | if target is specified. |
---|
[991df6a] | 85 | |
---|
[274f9ef] | 86 | Parameters |
---|
| 87 | ---------- |
---|
[991df6a] | 88 | |
---|
[274f9ef] | 89 | Return |
---|
| 90 | ------ |
---|
[991df6a] | 91 | ''' |
---|
| 92 | |
---|
[8652e7e] | 93 | args = get_install_cmdline_args() |
---|
[4971f63] | 94 | c = ControlFile(args.controlfile) |
---|
[54a8a01] | 95 | c.assign_args_to_control(args) |
---|
[6cda7c1] | 96 | check_install_conditions(c) |
---|
[991df6a] | 97 | |
---|
[54a8a01] | 98 | install_via_gateway(c) |
---|
[991df6a] | 99 | |
---|
[54a8a01] | 100 | return |
---|
[991df6a] | 101 | |
---|
[8652e7e] | 102 | def get_install_cmdline_args(): |
---|
[274f9ef] | 103 | '''Decomposes the command line arguments and assigns them to variables. |
---|
| 104 | Apply default values for non mentioned arguments. |
---|
[efdb01a] | 105 | |
---|
[274f9ef] | 106 | Parameters |
---|
| 107 | ---------- |
---|
[efdb01a] | 108 | |
---|
[274f9ef] | 109 | Return |
---|
| 110 | ------ |
---|
[6f951ca] | 111 | args : Namespace |
---|
[274f9ef] | 112 | Contains the commandline arguments from script/program call. |
---|
[efdb01a] | 113 | ''' |
---|
[54a8a01] | 114 | parser = ArgumentParser(description='Install flex_extract software locally or \ |
---|
[efdb01a] | 115 | on ECMWF machines', |
---|
| 116 | formatter_class=ArgumentDefaultsHelpFormatter) |
---|
| 117 | |
---|
[54a8a01] | 118 | parser.add_argument('--target', dest='install_target', default=None, |
---|
[efdb01a] | 119 | help="Valid targets: local | ecgate | cca , \ |
---|
| 120 | the latter two are at ECMWF") |
---|
[54a8a01] | 121 | parser.add_argument("--makefile", dest="makefile", default=None, |
---|
[efdb01a] | 122 | help='Name of Makefile to use for compiling CONVERT2') |
---|
[54a8a01] | 123 | parser.add_argument("--ecuid", dest="ecuid", default=None, |
---|
[efdb01a] | 124 | help='user id at ECMWF') |
---|
[54a8a01] | 125 | parser.add_argument("--ecgid", dest="ecgid", default=None, |
---|
[efdb01a] | 126 | help='group id at ECMWF') |
---|
[54a8a01] | 127 | parser.add_argument("--gateway", dest="gateway", default=None, |
---|
[efdb01a] | 128 | help='name of local gateway server') |
---|
[54a8a01] | 129 | parser.add_argument("--destination", dest="destination", default=None, |
---|
[efdb01a] | 130 | help='ecaccess destination, e.g. leo@genericSftp') |
---|
| 131 | |
---|
[fdfaf00] | 132 | parser.add_argument("--flexpartdir", dest="flexpartdir", |
---|
[54a8a01] | 133 | default=None, help="FLEXPART root directory on ECMWF \ |
---|
| 134 | servers (to find grib2flexpart and COMMAND file)\n\ |
---|
| 135 | Normally flex_extract resides in the scripts directory \ |
---|
[2fb99de] | 136 | of the FLEXPART distribution.") |
---|
[efdb01a] | 137 | |
---|
[54a8a01] | 138 | # arguments for job submission to ECMWF, only needed by submit.py |
---|
[efdb01a] | 139 | parser.add_argument("--job_template", dest='job_template', |
---|
| 140 | default="job.temp.o", |
---|
| 141 | help="job template file for submission to ECMWF") |
---|
| 142 | |
---|
| 143 | parser.add_argument("--controlfile", dest="controlfile", |
---|
| 144 | default='CONTROL.temp', |
---|
[991df6a] | 145 | help="file with CONTROL parameters") |
---|
[efdb01a] | 146 | |
---|
| 147 | args = parser.parse_args() |
---|
| 148 | |
---|
[54a8a01] | 149 | return args |
---|
| 150 | |
---|
[efdb01a] | 151 | |
---|
[54a8a01] | 152 | def install_via_gateway(c): |
---|
[274f9ef] | 153 | '''Perform the actual installation on local machine or prepare data |
---|
| 154 | transfer to remote gate and submit a job script which will |
---|
| 155 | install everything on the remote gate. |
---|
| 156 | |
---|
| 157 | Parameters |
---|
| 158 | ---------- |
---|
[6f951ca] | 159 | c : ControlFile |
---|
[274f9ef] | 160 | Contains all the parameters of CONTROL file and |
---|
| 161 | command line. |
---|
| 162 | |
---|
| 163 | Return |
---|
| 164 | ------ |
---|
| 165 | |
---|
[54a8a01] | 166 | ''' |
---|
[2fb99de] | 167 | import tarfile |
---|
| 168 | |
---|
| 169 | ecd = _config.PATH_FLEXEXTRACT_DIR |
---|
| 170 | tarball_name = _config.FLEXEXTRACT_DIRNAME + '.tar' |
---|
| 171 | tar_file = os.path.join(ecd, tarball_name) |
---|
[54a8a01] | 172 | |
---|
[2fb99de] | 173 | target_dirname = _config.FLEXEXTRACT_DIRNAME |
---|
| 174 | fortran_executable = _config.FORTRAN_EXECUTABLE |
---|
[54a8a01] | 175 | |
---|
[97e09f4] | 176 | if c.install_target.lower() != 'local': # ecgate or cca |
---|
[54a8a01] | 177 | |
---|
[2fb99de] | 178 | mk_compilejob(c.makefile, c.install_target, c.ecuid, c.ecgid, |
---|
[fdfaf00] | 179 | c.flexpartdir) |
---|
[54a8a01] | 180 | |
---|
[2fb99de] | 181 | mk_job_template(c.ecuid, c.ecgid, c.gateway, |
---|
[fdfaf00] | 182 | c.destination, c.flexpartdir) |
---|
[54a8a01] | 183 | |
---|
[2fb99de] | 184 | mk_env_vars(c.ecuid, c.ecgid, c.gateway, c.destination) |
---|
[54a8a01] | 185 | |
---|
[25b14be] | 186 | mk_tarball(tar_file, c.install_target) |
---|
[54a8a01] | 187 | |
---|
| 188 | put_file_to_ecserver(ecd, tarball_name, c.install_target, |
---|
| 189 | c.ecuid, c.ecgid) |
---|
| 190 | |
---|
[2fb99de] | 191 | submit_job_to_ecserver(c.install_target, |
---|
[25b14be] | 192 | os.path.join(_config.PATH_REL_JOBSCRIPTS, |
---|
[2fb99de] | 193 | _config.FILE_INSTALL_COMPILEJOB)) |
---|
[54a8a01] | 194 | |
---|
[de4dc27] | 195 | silent_remove(tar_file) |
---|
| 196 | |
---|
[2fb99de] | 197 | print('job compilation script has been submitted to ecgate for ' + |
---|
[fdfaf00] | 198 | 'installation in ' + c.flexpartdir + |
---|
[2fb99de] | 199 | '/' + target_dirname) |
---|
| 200 | print('You should get an email with subject "flexcompile" within ' + |
---|
| 201 | 'the next few minutes!') |
---|
[54a8a01] | 202 | |
---|
| 203 | else: #local |
---|
[fdfaf00] | 204 | if c.flexpartdir == _config.PATH_FLEXEXTRACT_DIR : |
---|
| 205 | print('WARNING: FLEXPARTDIR has not been specified') |
---|
[2fb99de] | 206 | print('flex_extract will be installed in here by compiling the ' + |
---|
| 207 | 'Fortran source in ' + _config.PATH_FORTRAN_SRC) |
---|
| 208 | os.chdir(_config.PATH_FORTRAN_SRC) |
---|
[54a8a01] | 209 | else: # creates the target working directory for flex_extract |
---|
[fdfaf00] | 210 | c.flexpartdir = os.path.expandvars(os.path.expanduser( |
---|
| 211 | c.flexpartdir)) |
---|
| 212 | if os.path.abspath(ecd) != os.path.abspath(c.flexpartdir): |
---|
[25b14be] | 213 | mk_tarball(tar_file, c.install_target) |
---|
[fdfaf00] | 214 | make_dir(os.path.join(c.flexpartdir, |
---|
[2fb99de] | 215 | target_dirname)) |
---|
[fdfaf00] | 216 | os.chdir(os.path.join(c.flexpartdir, |
---|
[2fb99de] | 217 | target_dirname)) |
---|
| 218 | un_tarball(tar_file) |
---|
[fdfaf00] | 219 | os.chdir(os.path.join(c.flexpartdir, |
---|
[2fb99de] | 220 | target_dirname, |
---|
[25b14be] | 221 | _config.PATH_REL_FORTRAN_SRC)) |
---|
[54a8a01] | 222 | |
---|
| 223 | # Create Fortran executable - CONVERT2 |
---|
[2fb99de] | 224 | print('Install ' + target_dirname + ' software at ' + |
---|
| 225 | c.install_target + ' in directory ' + |
---|
[fdfaf00] | 226 | os.path.abspath(c.flexpartdir) + '\n') |
---|
[2fb99de] | 227 | |
---|
[8652e7e] | 228 | del_convert_build('.') |
---|
| 229 | mk_convert_build('.', c.makefile) |
---|
[54a8a01] | 230 | |
---|
[2fb99de] | 231 | os.chdir(ecd) |
---|
| 232 | if os.path.isfile(tar_file): |
---|
| 233 | os.remove(tar_file) |
---|
[54a8a01] | 234 | |
---|
| 235 | return |
---|
| 236 | |
---|
[6cda7c1] | 237 | def check_install_conditions(c): |
---|
| 238 | '''Checks a couple of necessary attributes and conditions |
---|
| 239 | for the installation such as if they exist and contain values. |
---|
| 240 | Otherwise set default values. |
---|
| 241 | |
---|
| 242 | Parameters |
---|
| 243 | ---------- |
---|
[6f951ca] | 244 | c : ControlFile |
---|
[6cda7c1] | 245 | Contains all the parameters of CONTROL file and |
---|
| 246 | command line. |
---|
| 247 | |
---|
| 248 | |
---|
| 249 | Return |
---|
| 250 | ------ |
---|
| 251 | |
---|
| 252 | ''' |
---|
| 253 | |
---|
| 254 | if c.install_target and \ |
---|
| 255 | c.install_target not in _config.INSTALL_TARGETS: |
---|
| 256 | print('ERROR: unknown or missing installation target ') |
---|
| 257 | print('target: ', c.install_target) |
---|
| 258 | print('please specify correct installation target ' + |
---|
| 259 | str(INSTALL_TARGETS)) |
---|
| 260 | print('use -h or --help for help') |
---|
| 261 | sys.exit(1) |
---|
| 262 | |
---|
| 263 | if c.install_target and c.install_target != 'local': |
---|
| 264 | if not c.ecgid or not c.ecuid or \ |
---|
| 265 | not c.gateway or not c.destination: |
---|
| 266 | print('Please enter your ECMWF user id and group id as well ' + |
---|
| 267 | 'as the \nname of the local gateway and the ectrans ' + |
---|
| 268 | 'destination ') |
---|
| 269 | print('with command line options --ecuid --ecgid \ |
---|
| 270 | --gateway --destination') |
---|
| 271 | print('Try "' + sys.argv[0].split('/')[-1] + \ |
---|
| 272 | ' -h" to print usage information') |
---|
| 273 | print('Please consult ecaccess documentation or ECMWF user \ |
---|
| 274 | support for further details') |
---|
| 275 | sys.exit(1) |
---|
| 276 | |
---|
[fdfaf00] | 277 | if not c.flexpartdir: |
---|
| 278 | c.flexpartdir = '${HOME}' |
---|
[6cda7c1] | 279 | else: |
---|
[fdfaf00] | 280 | c.flexpartdir = c.flexpartdir |
---|
[6cda7c1] | 281 | else: # local |
---|
[fdfaf00] | 282 | if not c.flexpartdir: |
---|
| 283 | c.flexpartdir = _config.PATH_FLEXEXTRACT_DIR |
---|
[6cda7c1] | 284 | |
---|
| 285 | return |
---|
| 286 | |
---|
| 287 | |
---|
[25b14be] | 288 | def mk_tarball(tarball_path, target): |
---|
[274f9ef] | 289 | '''Creates a tarball with all necessary files which need to be sent to the |
---|
| 290 | installation directory. |
---|
| 291 | It does not matter if this is local or remote. |
---|
| 292 | Collects all python files, the Fortran source and makefiles, |
---|
| 293 | the ECMWF_ENV file, the CONTROL files as well as the |
---|
| 294 | template files. |
---|
| 295 | |
---|
| 296 | Parameters |
---|
| 297 | ---------- |
---|
[6f951ca] | 298 | tarball_path : str |
---|
[274f9ef] | 299 | The complete path to the tar file which will contain all |
---|
| 300 | relevant data for flex_extract. |
---|
| 301 | |
---|
[6f951ca] | 302 | target : str |
---|
[274f9ef] | 303 | The queue where the job is submitted to. |
---|
| 304 | |
---|
| 305 | Return |
---|
| 306 | ------ |
---|
| 307 | |
---|
[54a8a01] | 308 | ''' |
---|
[2fb99de] | 309 | from glob import glob |
---|
| 310 | |
---|
| 311 | print('Create tarball ...') |
---|
| 312 | |
---|
| 313 | # change to FLEXEXTRACT directory so that the tar can contain |
---|
| 314 | # relative pathes to the files and directories |
---|
| 315 | ecd = _config.PATH_FLEXEXTRACT_DIR + '/' |
---|
| 316 | os.chdir(ecd) |
---|
| 317 | |
---|
| 318 | # get lists of the files to be added to the tar file |
---|
[25b14be] | 319 | if target == 'local': |
---|
| 320 | ECMWF_ENV_FILE = [] |
---|
[3946de5] | 321 | runfile = [os.path.relpath(x, ecd) |
---|
| 322 | for x in UioFiles(_config.PATH_REL_RUN_DIR, |
---|
| 323 | 'run_local.sh').files] |
---|
[25b14be] | 324 | else: |
---|
| 325 | ECMWF_ENV_FILE = [_config.PATH_REL_ECMWF_ENV] |
---|
[3946de5] | 326 | runfile = [os.path.relpath(x, ecd) |
---|
| 327 | for x in UioFiles(_config.PATH_REL_RUN_DIR, |
---|
| 328 | 'run.sh').files] |
---|
[25b14be] | 329 | |
---|
[2fb99de] | 330 | pyfiles = [os.path.relpath(x, ecd) |
---|
[3946de5] | 331 | for x in UioFiles(_config.PATH_REL_PYTHON_SRC, '*py').files] |
---|
| 332 | pytestfiles = [os.path.relpath(x, ecd) |
---|
| 333 | for x in UioFiles(_config.PATH_REL_PYTHONTEST_SRC, '*py').files] |
---|
[2fb99de] | 334 | controlfiles = [os.path.relpath(x, ecd) |
---|
[3946de5] | 335 | for x in UioFiles(_config.PATH_REL_CONTROLFILES, |
---|
[25b14be] | 336 | 'CONTROL*').files] |
---|
[1eca806] | 337 | testfiles = [os.path.relpath(x, ecd) |
---|
| 338 | for x in UioFiles(_config.PATH_REL_TEST , '*').files] |
---|
[2fb99de] | 339 | tempfiles = [os.path.relpath(x, ecd) |
---|
[3946de5] | 340 | for x in UioFiles(_config.PATH_REL_TEMPLATES , '*.temp').files] |
---|
| 341 | nlfiles = [os.path.relpath(x, ecd) |
---|
| 342 | for x in UioFiles(_config.PATH_REL_TEMPLATES , '*.nl').files] |
---|
| 343 | gribtable = [os.path.relpath(x, ecd) |
---|
| 344 | for x in UioFiles(_config.PATH_REL_TEMPLATES , '*grib*').files] |
---|
[2fb99de] | 345 | ffiles = [os.path.relpath(x, ecd) |
---|
[3946de5] | 346 | for x in UioFiles(_config.PATH_REL_FORTRAN_SRC, '*.f*').files] |
---|
[2fb99de] | 347 | hfiles = [os.path.relpath(x, ecd) |
---|
[3946de5] | 348 | for x in UioFiles(_config.PATH_REL_FORTRAN_SRC, '*.h').files] |
---|
[2fb99de] | 349 | makefiles = [os.path.relpath(x, ecd) |
---|
[3946de5] | 350 | for x in UioFiles(_config.PATH_REL_FORTRAN_SRC, 'Makefile*').files] |
---|
| 351 | jobdir = [_config.PATH_REL_JOBSCRIPTS] |
---|
[2fb99de] | 352 | |
---|
| 353 | # concatenate single lists to one for a better looping |
---|
[3946de5] | 354 | filelist = pyfiles + pytestfiles + controlfiles + tempfiles + nlfiles + \ |
---|
| 355 | ffiles + gribtable + hfiles + makefiles + ECMWF_ENV_FILE + \ |
---|
[1eca806] | 356 | runfile + jobdir + testfiles +\ |
---|
[3946de5] | 357 | ['CODE_OF_CONDUCT.md', 'LICENSE.md', 'README.md'] |
---|
[2fb99de] | 358 | |
---|
| 359 | # create installation tar-file |
---|
[3946de5] | 360 | exclude_files = [".ksh"] |
---|
[54a8a01] | 361 | try: |
---|
[2fb99de] | 362 | with tarfile.open(tarball_path, "w:gz") as tar_handle: |
---|
| 363 | for file in filelist: |
---|
[3946de5] | 364 | tar_handle.add(file, recursive=False, |
---|
| 365 | filter=lambda tarinfo: None |
---|
| 366 | if os.path.splitext(tarinfo.name)[1] |
---|
| 367 | in exclude_files |
---|
| 368 | else tarinfo) |
---|
[54a8a01] | 369 | except subprocess.CalledProcessError as e: |
---|
[2fb99de] | 370 | print('... ERROR CODE:\n ... ' + str(e.returncode)) |
---|
| 371 | print('... ERROR MESSAGE:\n ... ' + str(e)) |
---|
| 372 | |
---|
[3946de5] | 373 | sys.exit('\n... could not make installation tar ball!') |
---|
| 374 | except OSError as e: |
---|
| 375 | print('... ERROR CODE: ' + str(e.errno)) |
---|
| 376 | print('... ERROR MESSAGE:\n \t ' + str(e.strerror)) |
---|
| 377 | |
---|
| 378 | sys.exit('\n... error occured while trying to read tar-file ' + |
---|
| 379 | str(tarball_path)) |
---|
[54a8a01] | 380 | |
---|
| 381 | return |
---|
| 382 | |
---|
[2fb99de] | 383 | |
---|
| 384 | def un_tarball(tarball_path): |
---|
[274f9ef] | 385 | '''Extracts the given tarball into current directory. |
---|
[2fb99de] | 386 | |
---|
[274f9ef] | 387 | Parameters |
---|
| 388 | ---------- |
---|
[6f951ca] | 389 | tarball_path : str |
---|
[274f9ef] | 390 | The complete path to the tar file which will contain all |
---|
| 391 | relevant data for flex_extract. |
---|
| 392 | |
---|
| 393 | Return |
---|
| 394 | ------ |
---|
[2fb99de] | 395 | |
---|
| 396 | ''' |
---|
| 397 | |
---|
| 398 | print('Untar ...') |
---|
| 399 | |
---|
[3946de5] | 400 | try: |
---|
| 401 | with tarfile.open(tarball_path) as tar_handle: |
---|
| 402 | tar_handle.extractall() |
---|
| 403 | except tarfile.TarError as e: |
---|
| 404 | sys.exit('\n... error occured while trying to read tar-file ' + |
---|
| 405 | str(tarball_path)) |
---|
| 406 | except OSError as e: |
---|
| 407 | print('... ERROR CODE: ' + str(e.errno)) |
---|
| 408 | print('... ERROR MESSAGE:\n \t ' + str(e.strerror)) |
---|
| 409 | |
---|
| 410 | sys.exit('\n... error occured while trying to read tar-file ' + |
---|
| 411 | str(tarball_path)) |
---|
[2fb99de] | 412 | |
---|
| 413 | return |
---|
| 414 | |
---|
| 415 | def mk_env_vars(ecuid, ecgid, gateway, destination): |
---|
[274f9ef] | 416 | '''Creates a file named ECMWF_ENV which contains the |
---|
| 417 | necessary environmental variables at ECMWF servers. |
---|
| 418 | It is based on the template ECMWF_ENV.template. |
---|
| 419 | |
---|
| 420 | Parameters |
---|
| 421 | ---------- |
---|
[6f951ca] | 422 | ecuid : str |
---|
[274f9ef] | 423 | The user id on ECMWF server. |
---|
[54a8a01] | 424 | |
---|
[6f951ca] | 425 | ecgid : str |
---|
[274f9ef] | 426 | The group id on ECMWF server. |
---|
[54a8a01] | 427 | |
---|
[6f951ca] | 428 | gateway : str |
---|
[274f9ef] | 429 | The gateway server the user is using. |
---|
[54a8a01] | 430 | |
---|
[6f951ca] | 431 | destination : str |
---|
[274f9ef] | 432 | The remote destination which is used to transfer files |
---|
| 433 | from ECMWF server to local gateway server. |
---|
[54a8a01] | 434 | |
---|
[274f9ef] | 435 | Return |
---|
| 436 | ------ |
---|
[54a8a01] | 437 | |
---|
| 438 | ''' |
---|
[0aaeb04] | 439 | from genshi.template.text import NewTextTemplate |
---|
| 440 | from genshi.template import TemplateLoader |
---|
[3946de5] | 441 | from genshi.template.eval import UndefinedError |
---|
[54a8a01] | 442 | |
---|
[3946de5] | 443 | try: |
---|
| 444 | loader = TemplateLoader(_config.PATH_TEMPLATES, auto_reload=False) |
---|
| 445 | ecmwfvars_template = loader.load(_config.TEMPFILE_USER_ENVVARS, |
---|
| 446 | cls=NewTextTemplate) |
---|
| 447 | |
---|
| 448 | stream = ecmwfvars_template.generate(user_name = ecuid, |
---|
| 449 | user_group = ecgid, |
---|
| 450 | gateway_name = gateway, |
---|
| 451 | destination_name = destination |
---|
| 452 | ) |
---|
| 453 | except UndefinedError as e: |
---|
| 454 | print('... ERROR ' + str(e)) |
---|
| 455 | |
---|
| 456 | sys.exit('\n... error occured while trying to generate template ' + |
---|
| 457 | _config.PATH_ECMWF_ENV) |
---|
| 458 | except OSError as e: |
---|
| 459 | print('... ERROR CODE: ' + str(e.errno)) |
---|
| 460 | print('... ERROR MESSAGE:\n \t ' + str(e.strerror)) |
---|
| 461 | |
---|
| 462 | sys.exit('\n... error occured while trying to generate template ' + |
---|
| 463 | _config.PATH_ECMWF_ENV) |
---|
[0aaeb04] | 464 | |
---|
[3946de5] | 465 | try: |
---|
| 466 | with open(_config.PATH_ECMWF_ENV, 'w') as f: |
---|
| 467 | f.write(stream.render('text')) |
---|
| 468 | except OSError as e: |
---|
| 469 | print('... ERROR CODE: ' + str(e.errno)) |
---|
| 470 | print('... ERROR MESSAGE:\n \t ' + str(e.strerror)) |
---|
[0aaeb04] | 471 | |
---|
[3946de5] | 472 | sys.exit('\n... error occured while trying to write ' + |
---|
| 473 | _config.PATH_ECMWF_ENV) |
---|
[54a8a01] | 474 | |
---|
| 475 | return |
---|
| 476 | |
---|
[2fb99de] | 477 | def mk_compilejob(makefile, target, ecuid, ecgid, fp_root): |
---|
[274f9ef] | 478 | '''Modifies the original job template file so that it is specified |
---|
| 479 | for the user and the environment were it will be applied. Result |
---|
| 480 | is stored in a new file "job.temp" in the python directory. |
---|
| 481 | |
---|
| 482 | Parameters |
---|
| 483 | ---------- |
---|
[6f951ca] | 484 | makefile : str |
---|
[274f9ef] | 485 | Name of the makefile which should be used to compile FORTRAN |
---|
| 486 | CONVERT2 program. |
---|
[54a8a01] | 487 | |
---|
[6f951ca] | 488 | target : str |
---|
[274f9ef] | 489 | The target where the installation should be done, e.g. the queue. |
---|
[54a8a01] | 490 | |
---|
[6f951ca] | 491 | ecuid : str |
---|
[274f9ef] | 492 | The user id on ECMWF server. |
---|
[54a8a01] | 493 | |
---|
[6f951ca] | 494 | ecgid : str |
---|
[274f9ef] | 495 | The group id on ECMWF server. |
---|
[54a8a01] | 496 | |
---|
[6f951ca] | 497 | fp_root : str |
---|
[274f9ef] | 498 | Path to the root directory of FLEXPART environment or flex_extract |
---|
| 499 | environment. |
---|
[54a8a01] | 500 | |
---|
[274f9ef] | 501 | Return |
---|
| 502 | ------ |
---|
[a4b6cef] | 503 | |
---|
[991df6a] | 504 | ''' |
---|
[0aaeb04] | 505 | from genshi.template.text import NewTextTemplate |
---|
| 506 | from genshi.template import TemplateLoader |
---|
[3946de5] | 507 | from genshi.template.eval import UndefinedError |
---|
[0aaeb04] | 508 | |
---|
| 509 | if fp_root == '../': |
---|
| 510 | fp_root = '$HOME' |
---|
| 511 | |
---|
[3946de5] | 512 | try: |
---|
| 513 | loader = TemplateLoader(_config.PATH_TEMPLATES, auto_reload=False) |
---|
| 514 | compile_template = loader.load(_config.TEMPFILE_INSTALL_COMPILEJOB, |
---|
| 515 | cls=NewTextTemplate) |
---|
| 516 | |
---|
| 517 | stream = compile_template.generate( |
---|
| 518 | usergroup = ecgid, |
---|
| 519 | username = ecuid, |
---|
| 520 | version_number = _config._VERSION_STR, |
---|
| 521 | fp_root_scripts = fp_root, |
---|
| 522 | makefile = makefile, |
---|
| 523 | fortran_program = _config.FORTRAN_EXECUTABLE |
---|
| 524 | ) |
---|
| 525 | except UndefinedError as e: |
---|
| 526 | print('... ERROR ' + str(e)) |
---|
| 527 | |
---|
| 528 | sys.exit('\n... error occured while trying to generate template ' + |
---|
| 529 | _config.TEMPFILE_INSTALL_COMPILEJOB) |
---|
| 530 | except OSError as e: |
---|
| 531 | print('... ERROR CODE: ' + str(e.errno)) |
---|
| 532 | print('... ERROR MESSAGE:\n \t ' + str(e.strerror)) |
---|
| 533 | |
---|
| 534 | sys.exit('\n... error occured while trying to generate template ' + |
---|
| 535 | _config.TEMPFILE_INSTALL_COMPILEJOB) |
---|
[0aaeb04] | 536 | |
---|
[3946de5] | 537 | try: |
---|
| 538 | compilejob = os.path.join(_config.PATH_JOBSCRIPTS, |
---|
| 539 | _config.FILE_INSTALL_COMPILEJOB) |
---|
[0aaeb04] | 540 | |
---|
[3946de5] | 541 | with open(compilejob, 'w') as f: |
---|
| 542 | f.write(stream.render('text')) |
---|
| 543 | except OSError as e: |
---|
| 544 | print('... ERROR CODE: ' + str(e.errno)) |
---|
| 545 | print('... ERROR MESSAGE:\n \t ' + str(e.strerror)) |
---|
| 546 | |
---|
| 547 | sys.exit('\n... error occured while trying to write ' + |
---|
| 548 | compilejob) |
---|
[0aaeb04] | 549 | |
---|
[54a8a01] | 550 | return |
---|
| 551 | |
---|
[2fb99de] | 552 | def mk_job_template(ecuid, ecgid, gateway, destination, fp_root): |
---|
[274f9ef] | 553 | '''Modifies the original job template file so that it is specified |
---|
| 554 | for the user and the environment were it will be applied. Result |
---|
| 555 | is stored in a new file. |
---|
[54a8a01] | 556 | |
---|
[274f9ef] | 557 | Parameters |
---|
| 558 | ---------- |
---|
[6f951ca] | 559 | ecuid : str |
---|
[274f9ef] | 560 | The user id on ECMWF server. |
---|
[54a8a01] | 561 | |
---|
[6f951ca] | 562 | ecgid : str |
---|
[274f9ef] | 563 | The group id on ECMWF server. |
---|
[54a8a01] | 564 | |
---|
[6f951ca] | 565 | gateway : str |
---|
[274f9ef] | 566 | The gateway server the user is using. |
---|
[54a8a01] | 567 | |
---|
[6f951ca] | 568 | destination : str |
---|
[274f9ef] | 569 | The remote destination which is used to transfer files |
---|
| 570 | from ECMWF server to local gateway server. |
---|
[54a8a01] | 571 | |
---|
[6f951ca] | 572 | fp_root : str |
---|
[274f9ef] | 573 | Path to the root directory of FLEXPART environment or flex_extract |
---|
| 574 | environment. |
---|
| 575 | |
---|
| 576 | Return |
---|
| 577 | ------ |
---|
[54a8a01] | 578 | |
---|
| 579 | ''' |
---|
[c5074d2] | 580 | from genshi.template.text import NewTextTemplate |
---|
| 581 | from genshi.template import TemplateLoader |
---|
[3946de5] | 582 | from genshi.template.eval import UndefinedError |
---|
[c5074d2] | 583 | |
---|
| 584 | fp_root_path_to_python = os.path.join(fp_root, |
---|
| 585 | _config.FLEXEXTRACT_DIRNAME, |
---|
[3946de5] | 586 | _config.PATH_REL_PYTHON_SRC) |
---|
[ff2a11c] | 587 | if '$' in fp_root_path_to_python: |
---|
| 588 | ind = fp_root_path_to_python.index('$') |
---|
| 589 | fp_root_path_to_python = fp_root_path_to_python[0:ind] + '$' + \ |
---|
| 590 | fp_root_path_to_python[ind:] |
---|
[3946de5] | 591 | |
---|
| 592 | try: |
---|
| 593 | loader = TemplateLoader(_config.PATH_TEMPLATES, auto_reload=False) |
---|
| 594 | compile_template = loader.load(_config.TEMPFILE_INSTALL_JOB, |
---|
| 595 | cls=NewTextTemplate) |
---|
| 596 | |
---|
| 597 | stream = compile_template.generate( |
---|
| 598 | usergroup = ecgid, |
---|
| 599 | username = ecuid, |
---|
| 600 | version_number = _config._VERSION_STR, |
---|
| 601 | fp_root_path = fp_root_path_to_python, |
---|
| 602 | ) |
---|
| 603 | except UndefinedError as e: |
---|
| 604 | print('... ERROR ' + str(e)) |
---|
[c5074d2] | 605 | |
---|
[3946de5] | 606 | sys.exit('\n... error occured while trying to generate template ' + |
---|
| 607 | _config.TEMPFILE_INSTALL_JOB) |
---|
| 608 | except OSError as e: |
---|
| 609 | print('... ERROR CODE: ' + str(e.errno)) |
---|
| 610 | print('... ERROR MESSAGE:\n \t ' + str(e.strerror)) |
---|
| 611 | |
---|
| 612 | sys.exit('\n... error occured while trying to generate template ' + |
---|
| 613 | _config.TEMPFILE_INSTALL_JOB) |
---|
| 614 | |
---|
| 615 | |
---|
| 616 | try: |
---|
| 617 | tempjobfile = os.path.join(_config.PATH_TEMPLATES, |
---|
| 618 | _config.TEMPFILE_JOB) |
---|
[c5074d2] | 619 | |
---|
[3946de5] | 620 | with open(tempjobfile, 'w') as f: |
---|
| 621 | f.write(stream.render('text')) |
---|
| 622 | except OSError as e: |
---|
| 623 | print('... ERROR CODE: ' + str(e.errno)) |
---|
| 624 | print('... ERROR MESSAGE:\n \t ' + str(e.strerror)) |
---|
[c5074d2] | 625 | |
---|
[3946de5] | 626 | sys.exit('\n... error occured while trying to write ' + |
---|
| 627 | tempjobfile) |
---|
[c5074d2] | 628 | |
---|
[54a8a01] | 629 | return |
---|
| 630 | |
---|
[8652e7e] | 631 | def del_convert_build(src_path): |
---|
[274f9ef] | 632 | '''Clean up the Fortran source directory and remove all |
---|
| 633 | build files (e.g. \*.o, \*.mod and CONVERT2) |
---|
| 634 | |
---|
| 635 | Parameters |
---|
| 636 | ---------- |
---|
[6f951ca] | 637 | src_path : str |
---|
[274f9ef] | 638 | Path to the fortran source directory. |
---|
[54a8a01] | 639 | |
---|
[274f9ef] | 640 | Return |
---|
| 641 | ------ |
---|
[54a8a01] | 642 | |
---|
| 643 | ''' |
---|
| 644 | |
---|
[2fb99de] | 645 | modfiles = UioFiles(src_path, '*.mod') |
---|
| 646 | objfiles = UioFiles(src_path, '*.o') |
---|
| 647 | exefile = UioFiles(src_path, _config.FORTRAN_EXECUTABLE) |
---|
[54a8a01] | 648 | |
---|
| 649 | modfiles.delete_files() |
---|
| 650 | objfiles.delete_files() |
---|
| 651 | exefile.delete_files() |
---|
| 652 | |
---|
| 653 | return |
---|
| 654 | |
---|
[8652e7e] | 655 | def mk_convert_build(src_path, makefile): |
---|
[274f9ef] | 656 | '''Compiles the Fortran code and generates the executable. |
---|
| 657 | |
---|
| 658 | Parameters |
---|
| 659 | ---------- |
---|
[6f951ca] | 660 | src_path : str |
---|
[274f9ef] | 661 | Path to the fortran source directory. |
---|
[54a8a01] | 662 | |
---|
[6f951ca] | 663 | makefile : str |
---|
[274f9ef] | 664 | The name of the makefile which should be used. |
---|
[54a8a01] | 665 | |
---|
[274f9ef] | 666 | Return |
---|
| 667 | ------ |
---|
[54a8a01] | 668 | |
---|
| 669 | ''' |
---|
| 670 | |
---|
| 671 | try: |
---|
[2fb99de] | 672 | print('Using makefile: ' + makefile) |
---|
| 673 | p = subprocess.Popen(['make', '-f', |
---|
| 674 | os.path.join(src_path, makefile)], |
---|
[54a8a01] | 675 | stdin=subprocess.PIPE, |
---|
| 676 | stdout=subprocess.PIPE, |
---|
| 677 | stderr=subprocess.PIPE, |
---|
| 678 | bufsize=1) |
---|
| 679 | pout, perr = p.communicate() |
---|
[2fb99de] | 680 | print(pout) |
---|
[54a8a01] | 681 | if p.returncode != 0: |
---|
[2fb99de] | 682 | print(perr) |
---|
| 683 | print('Please edit ' + makefile + |
---|
| 684 | ' or try another Makefile in the src directory.') |
---|
| 685 | print('Most likely GRIB_API_INCLUDE_DIR, GRIB_API_LIB ' |
---|
| 686 | 'and EMOSLIB must be adapted.') |
---|
| 687 | print('Available Makefiles:') |
---|
| 688 | print(UioFiles(src_path, 'Makefile*')) |
---|
[54a8a01] | 689 | sys.exit('Compilation failed!') |
---|
| 690 | except ValueError as e: |
---|
[2fb99de] | 691 | print('ERROR: Makefile call failed:') |
---|
| 692 | print(e) |
---|
[d69b677] | 693 | else: |
---|
[bf48c8a] | 694 | execute_subprocess(['ls', '-l', os.path.join(src_path, |
---|
| 695 | _config.FORTRAN_EXECUTABLE)], error_msg= |
---|
| 696 | 'FORTRAN EXECUTABLE COULD NOT BE FOUND!') |
---|
[a4b6cef] | 697 | |
---|
[d69b677] | 698 | return |
---|
| 699 | |
---|
[a4b6cef] | 700 | |
---|
[d69b677] | 701 | if __name__ == "__main__": |
---|
| 702 | main() |
---|