compass.provenance.write¶

compass.provenance.write(work_dir, test_cases, config=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
config (compass.config.CompassConfigParser) – Configuration options for this test case, a combination of user configs and the defaults for the machine and MPAS core