hydro.checks
============

.. py:module:: hydro.checks


Functions
---------

.. autoapisummary::

   hydro.checks.check_sorted
   hydro.checks.check_ancillary_variables
   hydro.checks.check_flags


Module Contents
---------------

.. py:function:: check_sorted(dataset)

   Check that the dataset is sorted by the rules in :func:`sort_ds`


.. py:function:: check_ancillary_variables(ds)

   Check that everything in an ancillary_variables attribute appears as a variable
   Check that every variable that is known ancillary appears in at least one ancillary_variable attribute


.. py:function:: check_flags(dataset, raises=True)

   Check WOCE flag values agaisnt their param and ensure that the param either has a value or is "nan" depedning on the flag definition.

   Return a boolean array of invalid locations?