[8463d78] | 1 | #!/usr/bin/env python3 |
---|
[54a8a01] | 2 | # -*- coding: utf-8 -*- |
---|
[6f951ca] | 3 | #******************************************************************************* |
---|
| 4 | # @Author: Anne Philipp (University of Vienna) |
---|
| 5 | # |
---|
| 6 | # @Date: August 2018 |
---|
| 7 | # |
---|
| 8 | # @Change History: |
---|
[a916e8f] | 9 | # June 2020 - Anne Philipp |
---|
| 10 | # - changed template filenames to .template |
---|
[75db9b0] | 11 | # August 2020 - Leopold Haimberger |
---|
| 12 | # - added another target for installation |
---|
[5606fc9] | 13 | # - added filename which will contain paths for system version |
---|
[75db9b0] | 14 | # - checks if software runs in normal local mode or system local mode |
---|
[5606fc9] | 15 | # and defines paths to user directory and executable paths |
---|
[01bd8aa] | 16 | # July 2022 - Anne Tipka (formerly Philipp) |
---|
| 17 | # - modified to account for changes on Bologna servers, |
---|
| 18 | # e.g. queue names and hostnames |
---|
[5cff464] | 19 | # August 2022 - Anne Tipka (formerly Philipp) |
---|
| 20 | # - changed name of compilejob.ksh to compilejob.sh |
---|
[6f951ca] | 21 | # |
---|
| 22 | # @License: |
---|
[026b359] | 23 | # (C) Copyright 2014-2020. |
---|
[6f951ca] | 24 | # Anne Philipp, Leopold Haimberger |
---|
| 25 | # |
---|
[44174de] | 26 | # SPDX-License-Identifier: CC-BY-4.0 |
---|
| 27 | # |
---|
[6f951ca] | 28 | # This work is licensed under the Creative Commons Attribution 4.0 |
---|
| 29 | # International License. To view a copy of this license, visit |
---|
| 30 | # http://creativecommons.org/licenses/by/4.0/ or send a letter to |
---|
| 31 | # Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. |
---|
| 32 | #******************************************************************************* |
---|
| 33 | '''Configurations for flex_extract. |
---|
| 34 | |
---|
| 35 | Defines a couple of global constant parameters as well as filenames |
---|
| 36 | and pathes. |
---|
[36a79af] | 37 | ''' |
---|
[54a8a01] | 38 | # ------------------------------------------------------------------------------ |
---|
| 39 | # MODULES |
---|
| 40 | # ------------------------------------------------------------------------------ |
---|
| 41 | import os |
---|
| 42 | import sys |
---|
| 43 | import inspect |
---|
[91e4dba] | 44 | import platform |
---|
| 45 | |
---|
| 46 | # ------------------------------------------------------------------------------ |
---|
| 47 | # PARAMETERS |
---|
| 48 | # ------------------------------------------------------------------------------ |
---|
[54a8a01] | 49 | |
---|
[5606fc9] | 50 | _VERSION_STR = '7.1.3' |
---|
[54a8a01] | 51 | |
---|
[5606fc9] | 52 | HOSTNAMES_BOLOGNA_LIST = ['ecs', 'aa', 'ab', 'ac', 'ad'] |
---|
| 53 | HOSTNAMES_READING_LIST = ['ecgb', 'cca', 'ccb'] |
---|
[f20af73] | 54 | |
---|
[5606fc9] | 55 | # name of environment variable on ECMWF Bologna servers |
---|
| 56 | # that indicates which cluster / host we are on |
---|
| 57 | HOSTENV_BOLOGNA = 'EC_CLUSTER' |
---|
| 58 | # name of environment variable on ECMWF Reading servers |
---|
| 59 | # that indicates which cluster / host we are on |
---|
| 60 | HOSTENV_READING = 'ECPLATFORM' |
---|
| 61 | |
---|
| 62 | # test if we are on a Bologna or Reading server |
---|
| 63 | |
---|
| 64 | # Test and set ECMWF Bologna server values |
---|
| 65 | if os.getenv(HOSTENV_BOLOGNA) is not None: |
---|
| 66 | ec_hostname = os.getenv(HOSTENV_BOLOGNA) |
---|
| 67 | FLAG_ON_ECMWFSERVER = ec_hostname in HOSTNAMES_BOLOGNA_LIST |
---|
[b6ea29e] | 68 | QUEUES_LIST = ['ecs', 'hpc'] |
---|
[5606fc9] | 69 | # Test and set ECMWF Reading server values |
---|
| 70 | elif os.getenv(HOSTENV_READING) is not None: |
---|
| 71 | ec_hostname = os.getenv(HOSTENV_READING) |
---|
| 72 | FLAG_ON_ECMWFSERVER = ec_hostname in HOSTNAMES_READING_LIST |
---|
| 73 | QUEUES_LIST = ['ecgate', 'cca', 'ccb'] |
---|
| 74 | else: |
---|
| 75 | FLAG_ON_ECMWFSERVER = False |
---|
| 76 | |
---|
[b6ea29e] | 77 | QUEUES_LIST_ALL = ['ecs', 'hpc', 'ecgate', 'cca', 'ccb'] |
---|
[70fee58] | 78 | |
---|
[b6ea29e] | 79 | INSTALL_TARGETS = ['local', 'syslocal', 'ecgate', 'cca', 'ccb', 'ecs', 'hpc'] |
---|
[6cda7c1] | 80 | |
---|
[0a75335] | 81 | CDS_DATASET_ML = 'reanalysis-era5-complete' |
---|
| 82 | CDS_DATASET_SFC = 'reanalysis-era5-single-levels' |
---|
[f20af73] | 83 | |
---|
[d8785f8] | 84 | # up-to-date available maximum level numbers at ECMWF, 05.10.2018 |
---|
| 85 | MAX_LEVEL_LIST = [16, 19, 31, 40, 50, 60, 62, 91, 137] |
---|
| 86 | |
---|
[2fb99de] | 87 | # ------------------------------------------------------------------------------ |
---|
| 88 | # FILENAMES |
---|
| 89 | # ------------------------------------------------------------------------------ |
---|
| 90 | |
---|
[295ff45] | 91 | FILE_MARS_REQUESTS = 'mars_requests.csv' |
---|
[0f89116] | 92 | FORTRAN_EXECUTABLE = 'calc_etadot' |
---|
[0aaeb04] | 93 | TEMPFILE_USER_ENVVARS = 'ECMWF_ENV.template' |
---|
[2fb99de] | 94 | FILE_USER_ENVVARS = 'ECMWF_ENV' |
---|
[373b74e] | 95 | TEMPFILE_INSTALL_COMPILEJOB = 'installscript.template' |
---|
[5cff464] | 96 | FILE_INSTALL_COMPILEJOB = 'compilejob.sh' |
---|
[373b74e] | 97 | TEMPFILE_INSTALL_JOB = 'jobscript.template' |
---|
[5f67883] | 98 | TEMPFILE_JOB = 'submitscript.template' |
---|
[2fb99de] | 99 | FILE_JOB_OD = 'job.ksh' |
---|
| 100 | FILE_JOB_OP = 'jopoper.ksh' |
---|
[5f67883] | 101 | TEMPFILE_NAMELIST = 'calc_etadot_nml.template' |
---|
[2fb99de] | 102 | FILE_NAMELIST = 'fort.4' |
---|
| 103 | FILE_GRIB_INDEX = 'date_time_stepRange.idx' |
---|
[25b14be] | 104 | FILE_GRIBTABLE = 'ecmwf_grib1_table_128' |
---|
[47be2684] | 105 | FILE_SYS_CONFIG = '.setup.rc' |
---|
[2fb99de] | 106 | |
---|
| 107 | # ------------------------------------------------------------------------------ |
---|
[25b14be] | 108 | # DIRECTORY NAMES |
---|
[2fb99de] | 109 | # ------------------------------------------------------------------------------ |
---|
| 110 | |
---|
[25b14be] | 111 | FLEXEXTRACT_DIRNAME = 'flex_extract_v' + _VERSION_STR |
---|
[ba99230] | 112 | INPUT_DIRNAME_DEFAULT = 'Workspace' |
---|
[25b14be] | 113 | |
---|
| 114 | # ------------------------------------------------------------------------------ |
---|
[47be2684] | 115 | # LOAD ENVIRONMENT VARIABLES FOR SYS VERSION; IF NECESSARRY |
---|
[25b14be] | 116 | # ------------------------------------------------------------------------------ |
---|
[2fb99de] | 117 | |
---|
| 118 | # path to the local python source files |
---|
[25b14be] | 119 | # first thing to get because the submitted python script starts in here |
---|
[222aa11] | 120 | PATH_LOCAL_PYTHON = os.path.dirname(os.path.abspath( |
---|
[54a8a01] | 121 | inspect.getfile(inspect.currentframe()))) |
---|
[2fb99de] | 122 | # add path to pythonpath |
---|
[222aa11] | 123 | if PATH_LOCAL_PYTHON not in sys.path: |
---|
| 124 | sys.path.append(PATH_LOCAL_PYTHON) |
---|
[47be2684] | 125 | |
---|
| 126 | # ------------------------------------------------------------------------------ |
---|
| 127 | # PATHES |
---|
| 128 | # ------------------------------------------------------------------------------ |
---|
| 129 | |
---|
[25b14be] | 130 | PATH_FLEXEXTRACT_DIR = os.path.normpath(os.path.dirname(os.path.abspath( |
---|
| 131 | inspect.getfile(inspect.currentframe()))) + '/../../') |
---|
[47be2684] | 132 | if not os.path.isdir(os.path.join(PATH_FLEXEXTRACT_DIR,'Run')): |
---|
| 133 | # if it does not exist, we have a system installation in place |
---|
| 134 | # we need to have a sys and user path |
---|
| 135 | # configure correct system path |
---|
| 136 | PATH_SYSTEM_DIR = os.path.join(PATH_FLEXEXTRACT_DIR, FLEXEXTRACT_DIRNAME) |
---|
| 137 | # configure correct user path |
---|
| 138 | PATH_FLEXEXTRACT_DIR = os.environ.get('FLEXEXTRACT_USER_DIR') |
---|
| 139 | else: |
---|
| 140 | PATH_SYSTEM_DIR = PATH_FLEXEXTRACT_DIR |
---|
| 141 | |
---|
[ba99230] | 142 | PATH_RUN_DIR = os.path.join(PATH_FLEXEXTRACT_DIR, 'Run') |
---|
[47be2684] | 143 | PATH_SOURCES = os.path.join(PATH_SYSTEM_DIR, 'Source') |
---|
[ba99230] | 144 | PATH_TEMPLATES = os.path.join(PATH_FLEXEXTRACT_DIR, 'Templates') |
---|
[25b14be] | 145 | PATH_ECMWF_ENV = os.path.join(PATH_RUN_DIR, FILE_USER_ENVVARS) |
---|
| 146 | PATH_GRIBTABLE = os.path.join(PATH_TEMPLATES, FILE_GRIBTABLE) |
---|
[ba99230] | 147 | PATH_JOBSCRIPTS = os.path.join(PATH_RUN_DIR, 'Jobscripts') |
---|
[47be2684] | 148 | if os.path.isdir(os.path.join(PATH_SYSTEM_DIR,'Fortran')): |
---|
| 149 | PATH_FORTRAN_SRC = PATH_SYSTEM_DIR |
---|
| 150 | else: |
---|
| 151 | PATH_FORTRAN_SRC = os.path.join(PATH_SOURCES, 'Fortran') |
---|
[ba99230] | 152 | PATH_PYTHONTEST_SRC = os.path.join(PATH_SOURCES, 'Pythontest') |
---|
[25b14be] | 153 | PATH_INPUT_DIR = os.path.join(PATH_RUN_DIR, INPUT_DIRNAME_DEFAULT) |
---|
[0f89116] | 154 | PATH_TEST = os.path.join(PATH_FLEXEXTRACT_DIR, 'Testing') |
---|
[36a79af] | 155 | if os.getenv('CONTROL'): |
---|
[91e4dba] | 156 | # this is only needed if (gateway) version with job script is used! |
---|
[5d42acd] | 157 | # because job is directly submitted from SCRATCH and because the |
---|
| 158 | # CONTROL file is stored there, the normal path is not valid. |
---|
[70fee58] | 159 | PATH_CONTROLFILES = '.' |
---|
[5d42acd] | 160 | else: |
---|
[ba99230] | 161 | PATH_CONTROLFILES = os.path.join(PATH_RUN_DIR, 'Control') |
---|
[25b14be] | 162 | # |
---|
| 163 | # ------------------------------------------------------------------------------ |
---|
[6f951ca] | 164 | # RELATIVE PATHES FOR INSTALLATION TAR-BALL |
---|
[25b14be] | 165 | # ------------------------------------------------------------------------------ |
---|
[dda0e9d] | 166 | |
---|
[3946de5] | 167 | PATH_REL_PYTHON_SRC = os.path.relpath(PATH_LOCAL_PYTHON, PATH_FLEXEXTRACT_DIR) |
---|
| 168 | PATH_REL_PYTHONTEST_SRC = os.path.relpath(PATH_PYTHONTEST_SRC, PATH_FLEXEXTRACT_DIR) |
---|
[25b14be] | 169 | PATH_REL_CONTROLFILES = os.path.relpath(PATH_CONTROLFILES, PATH_FLEXEXTRACT_DIR) |
---|
| 170 | PATH_REL_TEMPLATES = os.path.relpath(PATH_TEMPLATES, PATH_FLEXEXTRACT_DIR) |
---|
| 171 | PATH_REL_ECMWF_ENV = os.path.relpath(PATH_ECMWF_ENV, PATH_FLEXEXTRACT_DIR) |
---|
| 172 | PATH_REL_RUN_DIR = os.path.relpath(PATH_RUN_DIR, PATH_FLEXEXTRACT_DIR) |
---|
| 173 | PATH_REL_JOBSCRIPTS = os.path.relpath(PATH_JOBSCRIPTS, PATH_FLEXEXTRACT_DIR) |
---|
| 174 | PATH_REL_FORTRAN_SRC = os.path.relpath(PATH_FORTRAN_SRC, PATH_FLEXEXTRACT_DIR) |
---|
[1eca806] | 175 | PATH_REL_TEST = os.path.relpath(PATH_TEST, PATH_FLEXEXTRACT_DIR) |
---|