generate_FV3LAM_wflow module

User interface to create an experiment directory consistent with the user-defined YAML configuration file.

generate_FV3LAM_wflow(ushdir: str, config: str = 'config.yaml', logfile: str = 'log.generate_FV3LAM_wflow', debug: bool = False) → str

Sets up a forecast experiment and creates a workflow (according to the parameters specified in the configuration file)

Parameters:

  • ushdir (str) – The full path of the ush/ directory where this script is located

  • logfile (str) – The name of the file where logging is written

  • debug (bool) – Enable extra output for debugging

Returns:

EXPTDIR (str) – The full path of the directory where this experiment has been generated

setup_fv3_namelist(expt_config, debug)

Updates parameters specific to the FV3ATM namelist for the run_fcst step.

Parameters:

  • expt_config (dict) – The full experiment configuration dictionary

  • debug (bool) – Enable extra output for debugging

setup_logging(logfile: str = 'log.generate_FV3LAM_wflow', debug: bool = False) → None

Sets up logging, printing high-priority (INFO and higher) messages to screen and printing all messages with detailed timing and routine info in the specified text file. If debug = True, print all messages to both screen and log file.

Parameters:

  • logfile (str) – The name of the file where logging information is written

  • debug (bool) – Enable extra output for debugging

Returns:

None