polaris.Step.add_property_check

Step.add_property_check(filename, check_properties, baseline='init', time_index_end=-1)

Add a single conservation comparison for an output file

Parameters:

• filename (str) – The relative path of the output file within the step’s work directory

• check_properties (list of str) – A list of conservation properties to check, e.g. ['mass conservation', 'salt conservation']

• baseline ({'init'} or int, optional) – The state to compare the conservation properties against, either 'init' for the initial condition or a time index in the output file

• time_index_end (int, optional) – The time index in the output file at the end of the comparison