lib.adf_obs
===========

.. py:module:: lib.adf_obs

.. autoapi-nested-parse::

   Observations (obs) class for the Atmospheric
   Diagnostics Framework (ADF).
   This class inherits from the AdfInfo class.

   Currently this class does three things:

   1.  Initializes an instance of AdfInfo.

   2.  Sets the "variable_defaults" ADF variable.

   3.  Checks whether any requested variable is supposed
       to have a land or ocean mask, and if so then
       adds land and ocean fractions to the variable
       list.

   4.  If a model vs obs run, then creates a
       dictionary of what observational dataset
       is associated with each requested variable,
       along with any relevant observational meta-data.

   This class also provide methods for extracting
   the observational data and meta-data for use
   in various scripts.



Classes
-------

.. autoapisummary::

   lib.adf_obs.AdfObs


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

.. py:class:: AdfObs(config_file, debug=False)

   Bases: :py:obj:`lib.adf_info.AdfInfo`


   Observations class, which initializes
   an AdfInfo object and provides
   additional variables and methods
   needed for managing observational data.


   .. py:attribute:: __var_obs_dict


   .. py:property:: variable_defaults

      Return a copy of the '__variable_defaults' dictionary to the user if requested.


   .. py:property:: var_obs_dict

      Return a copy of the "var_obs_dict" list to the user if requested.