fre.pp.nccheck_script module

Checks that a netCDF (.nc) file contains expected number of timesteps. Used by fre pp histval and fre pp ppval.

fre.pp.nccheck_script.check(file_path: str, num_steps: int)

Compares the number of timesteps in a given netCDF (.nc) file to the number of expected timesteps

Parameters:
  • file_path (str) – path to netcdf file for checking

  • num_steps (int) – number of expected timesteps

Raises:

ValueError – Actual number of timesteps differs from expected number of timesteps

Returns:

0 unless number of timesteps differs from expectation

Return type:

int