source: flex_extract.git/Source/Python/_config.py @ 01bd8aa

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#*******************************************************************************
# @Author: Anne Philipp (University of Vienna)
#
# @Date: August 2018
#
# @Change History:
#      June 2020 - Anne Philipp
#         - changed template filenames to .template
#      August 2020 - Leopold Haimberger
#         - added another target for installation
#         - added filename which will contain paths for system version
#         - checks if software runs in normal local mode or system local mode
#           and defines paths to user directory and executable paths
#      July 2022 - Anne Tipka (formerly Philipp)
#         - modified to account for changes on Bologna servers,
#           e.g. queue names and hostnames
#
# @License:
#    (C) Copyright 2014-2020.
#    Anne Philipp, Leopold Haimberger
#
#    SPDX-License-Identifier: CC-BY-4.0
#
#    This work is licensed under the Creative Commons Attribution 4.0
#    International License. To view a copy of this license, visit
#    http://creativecommons.org/licenses/by/4.0/ or send a letter to
#    Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
#*******************************************************************************
'''Configurations for flex_extract.

Defines a couple of global constant parameters as well as filenames
and pathes.
'''
# ------------------------------------------------------------------------------
# MODULES
# ------------------------------------------------------------------------------
import os
import sys
import inspect
import platform

# ------------------------------------------------------------------------------
# PARAMETERS
# ------------------------------------------------------------------------------

_VERSION_STR = '7.1.3'

HOSTNAMES_BOLOGNA_LIST = ['ecs', 'aa', 'ab', 'ac', 'ad']
HOSTNAMES_READING_LIST = ['ecgb', 'cca', 'ccb']

# name of environment variable on ECMWF Bologna servers
# that indicates which cluster / host we are on
HOSTENV_BOLOGNA = 'EC_CLUSTER'
# name of environment variable on ECMWF Reading servers
# that indicates which cluster / host we are on
HOSTENV_READING = 'ECPLATFORM'

# test if we are on a Bologna or Reading server

# Test and set ECMWF Bologna server values
if os.getenv(HOSTENV_BOLOGNA) is not None:
    ec_hostname = os.getenv(HOSTENV_BOLOGNA)
    FLAG_ON_ECMWFSERVER = ec_hostname in HOSTNAMES_BOLOGNA_LIST
    QUEUES_LIST = ['ecs', 'hpc']
# Test and set ECMWF Reading server values
elif os.getenv(HOSTENV_READING) is not None:
    ec_hostname = os.getenv(HOSTENV_READING)
    FLAG_ON_ECMWFSERVER = ec_hostname in HOSTNAMES_READING_LIST
    QUEUES_LIST = ['ecgate', 'cca', 'ccb']
else:
    FLAG_ON_ECMWFSERVER = False

QUEUES_LIST_ALL = ['ecs', 'hpc', 'ecgate', 'cca', 'ccb']

INSTALL_TARGETS = ['local', 'syslocal', 'ecgate', 'cca', 'ccb', 'ecs', 'hpc']

CDS_DATASET_ML = 'reanalysis-era5-complete'
CDS_DATASET_SFC = 'reanalysis-era5-single-levels'

# up-to-date available maximum level numbers at ECMWF, 05.10.2018
MAX_LEVEL_LIST = [16, 19, 31, 40, 50, 60, 62, 91, 137]

# ------------------------------------------------------------------------------
# FILENAMES
# ------------------------------------------------------------------------------

FILE_MARS_REQUESTS = 'mars_requests.csv'
FORTRAN_EXECUTABLE = 'calc_etadot'
TEMPFILE_USER_ENVVARS = 'ECMWF_ENV.template'
FILE_USER_ENVVARS = 'ECMWF_ENV'
TEMPFILE_INSTALL_COMPILEJOB = 'installscript.template'
FILE_INSTALL_COMPILEJOB = 'compilejob.ksh'
TEMPFILE_INSTALL_JOB = 'jobscript.template'
TEMPFILE_JOB = 'submitscript.template'
FILE_JOB_OD = 'job.ksh'
FILE_JOB_OP = 'jopoper.ksh'
TEMPFILE_NAMELIST = 'calc_etadot_nml.template'
FILE_NAMELIST = 'fort.4'
FILE_GRIB_INDEX = 'date_time_stepRange.idx'
FILE_GRIBTABLE = 'ecmwf_grib1_table_128'
FILE_SYS_CONFIG = '.setup.rc'

# ------------------------------------------------------------------------------
# DIRECTORY NAMES
# ------------------------------------------------------------------------------

FLEXEXTRACT_DIRNAME = 'flex_extract_v' + _VERSION_STR
INPUT_DIRNAME_DEFAULT = 'Workspace'

# ------------------------------------------------------------------------------
#  LOAD ENVIRONMENT VARIABLES FOR SYS VERSION; IF NECESSARRY
# ------------------------------------------------------------------------------

# path to the local python source files
# first thing to get because the submitted python script starts in here
PATH_LOCAL_PYTHON = os.path.dirname(os.path.abspath(
    inspect.getfile(inspect.currentframe())))
# add path to pythonpath
if PATH_LOCAL_PYTHON not in sys.path:
    sys.path.append(PATH_LOCAL_PYTHON)

# ------------------------------------------------------------------------------
#  PATHES
# ------------------------------------------------------------------------------

PATH_FLEXEXTRACT_DIR = os.path.normpath(os.path.dirname(os.path.abspath(
    inspect.getfile(inspect.currentframe()))) + '/../../')
if not os.path.isdir(os.path.join(PATH_FLEXEXTRACT_DIR,'Run')):
    # if it does not exist, we have a system installation in place
    # we need to have a sys and user path
    # configure correct system path
    PATH_SYSTEM_DIR = os.path.join(PATH_FLEXEXTRACT_DIR, FLEXEXTRACT_DIRNAME)
    # configure correct user path
    PATH_FLEXEXTRACT_DIR = os.environ.get('FLEXEXTRACT_USER_DIR')
else:
    PATH_SYSTEM_DIR = PATH_FLEXEXTRACT_DIR

PATH_RUN_DIR = os.path.join(PATH_FLEXEXTRACT_DIR, 'Run')
PATH_SOURCES = os.path.join(PATH_SYSTEM_DIR, 'Source')
PATH_TEMPLATES = os.path.join(PATH_FLEXEXTRACT_DIR, 'Templates')
PATH_ECMWF_ENV = os.path.join(PATH_RUN_DIR, FILE_USER_ENVVARS)
PATH_GRIBTABLE = os.path.join(PATH_TEMPLATES, FILE_GRIBTABLE)
PATH_JOBSCRIPTS = os.path.join(PATH_RUN_DIR, 'Jobscripts')
if os.path.isdir(os.path.join(PATH_SYSTEM_DIR,'Fortran')):
    PATH_FORTRAN_SRC = PATH_SYSTEM_DIR
else:
    PATH_FORTRAN_SRC = os.path.join(PATH_SOURCES, 'Fortran')
PATH_PYTHONTEST_SRC = os.path.join(PATH_SOURCES, 'Pythontest')
PATH_INPUT_DIR = os.path.join(PATH_RUN_DIR, INPUT_DIRNAME_DEFAULT)
PATH_TEST = os.path.join(PATH_FLEXEXTRACT_DIR, 'Testing')
if os.getenv('CONTROL'):
    # this is only needed if (gateway) version with job script is used!
    # because job is directly submitted from SCRATCH and because the
    # CONTROL file is stored there, the normal path is not valid.
    PATH_CONTROLFILES = '.'
else:
    PATH_CONTROLFILES = os.path.join(PATH_RUN_DIR, 'Control')
#
# ------------------------------------------------------------------------------
# RELATIVE PATHES FOR INSTALLATION TAR-BALL
# ------------------------------------------------------------------------------

PATH_REL_PYTHON_SRC = os.path.relpath(PATH_LOCAL_PYTHON, PATH_FLEXEXTRACT_DIR)
PATH_REL_PYTHONTEST_SRC = os.path.relpath(PATH_PYTHONTEST_SRC, PATH_FLEXEXTRACT_DIR)
PATH_REL_CONTROLFILES = os.path.relpath(PATH_CONTROLFILES, PATH_FLEXEXTRACT_DIR)
PATH_REL_TEMPLATES = os.path.relpath(PATH_TEMPLATES, PATH_FLEXEXTRACT_DIR)
PATH_REL_ECMWF_ENV = os.path.relpath(PATH_ECMWF_ENV, PATH_FLEXEXTRACT_DIR)
PATH_REL_RUN_DIR = os.path.relpath(PATH_RUN_DIR, PATH_FLEXEXTRACT_DIR)
PATH_REL_JOBSCRIPTS = os.path.relpath(PATH_JOBSCRIPTS, PATH_FLEXEXTRACT_DIR)
PATH_REL_FORTRAN_SRC = os.path.relpath(PATH_FORTRAN_SRC, PATH_FLEXEXTRACT_DIR)
PATH_REL_TEST = os.path.relpath(PATH_TEST, PATH_FLEXEXTRACT_DIR)