compass.setup.setup_cases

compass.setup.setup_cases(tests=None, numbers=None, config_file=None, machine=None, work_dir=None, baseline_dir=None, mpas_model_path=None, suite_name='custom', cached=None, copy_executable=False)[source]

Set up one or more test cases

Parameters:

  • tests (list of str, optional) – Relative paths for a test cases to set up

  • numbers (list of str, optional) – Case numbers to setup, as listed from compass list, optionally with a suffix c to indicate that all steps in that test case should be cached

  • config_file ({str, None}, optional) – Configuration file with custom options for setting up and running test cases

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

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

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

  • mpas_model_path (str, optional) – The relative or absolute path to the root of a branch where the MPAS model has been built

  • suite_name (str, optional) – The name of the test suite if tests are being set up through a test suite or 'custom' if not

  • cached (list of list of str, optional) – For each test in tests, which steps (if any) should be cached, or a list with “_all” as the first entry if all steps in the test case should be cached

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

Returns:

test_cases (dict of compass.TestCase) – A dictionary of test cases, with the relative path in the work directory as keys