polaris.suite.setup_suite

polaris.suite.setup_suite(component, suite_name, work_dir, **kwargs)

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

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

• kwargs (dict, optional) – Additional keyword arguments passed to setup_tasks