variable_flagging
=================

.. py:module:: variable_flagging


Functions
---------

.. autoapisummary::

   variable_flagging.mark_variable_assigned
   variable_flagging.is_variable_assigned


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

.. py:function:: mark_variable_assigned(var)

   Function to set a flag on the variable in the dataset to mark it as actually available and not just filled with default values.

   Should only be called on variables that had a non-default value assigned.
   Variables that have not been flagged, may be dropped upon finalization of the loading routine.

   :param var: The variable to set the flag on to mark it as assigned to.
   :type var: xr.DataArray


.. py:function:: is_variable_assigned(var)

   Function to check a flag on a variable in a dataset whether it has been assigned with actual values.

   :param var: The variable to check for a set "__assigned" flag.
   :type var: xr.DataArray