polaris.suite.setup_suite

polaris.suite.setup_suite(component, suite_name, work_dir, config_file=None, machine=None, baseline_dir=None, component_path=None, copy_executable=False, clean=False, model=None)[source]

Set up a suite of tasks

Parameters:

  • component (str) – The component (‘ocean’, ‘landice’, etc.) of the suite

  • suite_name (str) – The name of the suite. A file <suite_name>.txt must exist within the core’s suites package that lists the paths of the tasks in the suite

  • config_file (str, optional) – Configuration file with custom options for setting up and running tasks

  • machine (str, optional) – The name of one of the machines with defined config options, which can be listed with polaris list --machines

  • work_dir (str, optional) – A directory that will serve as the base for creating task directories

  • baseline_dir (str, optional) – Location of baselines that can be compared to

  • component_path (str, optional) – The relative or absolute path to the location where the model and default namelists have been built

  • copy_executable (bool, optional) – Whether to copy the MPAS executable to the work directory

  • clean (bool, optional) – Whether to delete the contents of the base work directory before setting up the suite

  • model (str, optional) – The model to run