search

COSIMA / om3-scripts

A place for scripts related to ACCESS-OM3
Apache License 2.0
2 stars 0 forks source link

Add Experiment Manager tools #33

Open minghangli-uni opened 2 months ago

minghangli-uni commented 2 months ago

Add Experiment Manager tools to om3-scripts.

The ACCESS-OM3 Experiment Manager is a Python-based tool designed to streamline the setup and management of ACCESS-OM3 experiments. It automates the creation of experiment directories, applies parameter changes, and updates relevant configuration files based on user-defined settings in a YAML configuration file.

There are two script files,

  1. Expts_manager.py:

    • contains the ExptManager class, which faciliates the setup, configuration, and execution of experiments. Key functionalities include:
    • Handles configuration based on user-defined parameters.
    • Automates the creation of directories and ensures a smooth workflow for running experiments.
    • Supports updates of parameters, including those for MOM6, namelists (.nml files) and coupling timestep (cpl_dt).
    • Automates the initiation of experiment runs and manages the number of runs to be executed.
    • Skips experiment runs if parameters are identical to the control experiment. This functionality can be switched on and off (currently applicable only to namelists).
    • Integrates Git management during experiments to track changes.
    • Updates experiment metadata, including details and descriptions, facilitated by Payu.

  2. Expts_manager.yaml:

    • A YAML configuration input file, which is used to define the parameters and settings required for managing control and perturbation experiments. The configuration file enables users to,
    • clone necessary repositories,
    • setup experiments with customised configurations, and,
    • manage diagnostic tools and parameter tunning.
minghangli-uni commented 1 month ago

Since I plan to add more features to this tool, I will keep this issue open for now.