compass.provenance.write¶

compass.provenance.write(work_dir, test_cases, mpas_core=None, config_filename=None, mpas_model_path=None)[source]¶

Write a file with provenance, such as the git version, conda packages, command, and test cases, to the work directory

Parameters

work_dir (str) – The path to the work directory where the test cases will be set up
test_cases (dict) – A dictionary describing all of the test cases and their steps
mpas_core (str) – The name of the MPAS core
config_filename (str, optional) – The name of config file with custom options for setting up and running test cases
mpas_model_path (str, optional) – The relative or absolute path to the root of a branch where the MPAS model has been built