compass.setup.setup_case

compass.setup.setup_case(path, test_case, config_file, machine, work_dir, baseline_dir, mpas_model_path, cached_steps, copy_executable)[source]

Set up one or more test cases

Parameters:

  • path (str) – Relative path for a test cases to set up

  • test_case (compass.TestCase) – A test case to set up

  • config_file (str) – Configuration file with custom options for setting up and running test cases

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

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

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

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

  • cached_steps (list of str) –

    Which steps (if any) should be cached. If all steps should be cached,

    the first entry is “_all”

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