monitor_jobs module

monitor_jobs(expts_dict: dict, monitor_file: str = '', procs: int = 1, mode: str = 'continuous', debug: bool = False) → str

Monitors and runs jobs for the specified experiment using Rocoto

Parameters:

  • expts_dict (dict) – A dictionary containing the information needed to run one or more experiments. See example file monitor_jobs.yaml.

  • monitor_file (str) – [optional] Name of the file used to monitor experiment results. Default is monitor_jobs.yaml.

  • procs (int) – [optional] The number of parallel processes to run

  • mode (str) – [optional] Mode of job monitoring. Options: (1) 'continuous' (default): monitor jobs continuously until complete or (2) 'advance': increment jobs once, then quit.

  • debug (bool) – [optional] Enable extra output for debugging

Returns:

monitor_file – The name of the file used for job monitoring (when script is finished, this contains results/summary)

setup_logging(logfile: str = 'log.run_WE2E_tests', 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.

Parameters:

  • logfile (str) – Name of log file for WE2E tests (default: log.run_WE2E_tests)

  • debug (bool) – Set to True to enable extra output for debugging

Returns:

None