eophis.utils package

Submodules

eophis.utils.logs module

This module creates and configures eophis log files.

  • Copyright (c) 2023 IGE-MEOM

    Eophis is released under an MIT License. See the LICENSE file for details.

eophis.utils.logs.abort(message='Error not described')

Writes an error message in ‘eophis.err’ log file. Writes that a error occured in ‘eophis.out’ log file. Stops execution.

Parameters:

message (string) – error message to be logged

eophis.utils.logs.info(message='', writer=0)

Writes informational message in ‘eophis.out’ log file.

Parameters:

  • message (string) – message to be logged

  • writer (int) – rank of process that shall write

eophis.utils.logs.warning(message='Warning not described')

Writes a warning message in ‘eophis.err’ log file. Writes that a warning occured in ‘eophis.out’ log file.

Parameters:

message (string) – warning message to be logged

eophis.utils.params module

This module contains useful constants.

  • Copyright (c) 2023 IGE-MEOM

    Eophis is released under an MIT License. See the LICENSE file for details.

class eophis.utils.params.Freqs

Bases: object

This class contains pre-defined exchange frequencies.

Notes

STATIC is equal -1 to be identified by Namcouple. It is replaced by the total simulation time value during writing of OASIS namelist.

DAILY = 86400
HOURLY = 3600
MINUTLY = 60
MONTHLY = 2678400
STATIC = -1
WEEKLY = 604800
YEARLY = 31536000
eophis.utils.params.set_mode(mode_to_set)

Changes eophis Mode.

Parameters:

mode_to_set (string) – ‘preprod’ or ‘prod’

Notes

  • preprod : Preprodution mode enables namelists writing and disables OASIS initialization

  • prod : Production mode disables namelist writing and enables OASIS initialization and namelist consistency checking (default mode)

eophis.utils.worker module

This module contains tools for parallel execution.

  • Copyright (c) 2023 IGE-MEOM

    Eophis is released under an MIT License. See the LICENSE file for details.

Module contents

Miscellaneous tools.

  • Copyright (c) 2023 IGE-MEOM

    Eophis is released under an MIT License. See the LICENSE file for details.