polaris.Step.add_output_file

Step.add_output_file(filename, validate_vars=None, check_properties=None, check_properties_baseline='init', check_properties_time_index_end=-1)[source]

Add the output file to the step

Parameters:

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

  • validate_vars (list of str, optional) – A list of variables to validate against a baseline

  • check_properties (list of str, optional) – A list of conservation properties to check for this file, e.g. ['mass conservation', 'salt conservation']. Any surface forcing flux variables present in the file are integrated over the duration of the comparison (assuming they are constant in time) and used as the expected change in the corresponding budget. Each call adds a single conservation comparison, so call this method again (or use add_property_check()) to check conservation over another time interval of the same file.

  • check_properties_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

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