lib.adf_dataset
===============

.. py:module:: lib.adf_dataset


Classes
-------

.. autoapisummary::

   lib.adf_dataset.AdfData


Functions
---------

.. autoapisummary::

   lib.adf_dataset.my_formatwarning


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

.. py:function:: my_formatwarning(msg, *args, **kwargs)

.. py:class:: AdfData(adfobj)

   A class instantiated with an AdfDiag object.
   Methods provide means to load data.
   This class does not interact with plotting,
   just provides access to data locations and loading data.

   A future need is to add some kind of frequency/sampling
   parameters to allow for non-h0 files.



   .. py:attribute:: adf


   .. py:attribute:: model_rgrid_loc


   .. py:attribute:: case_names


   .. py:attribute:: test_nicknames


   .. py:attribute:: base_nickname


   .. py:attribute:: ref_nickname


   .. py:method:: set_reference()

      Set attributes for reference (aka baseline) data location, names, and variables.



   .. py:method:: set_ref_var_loc()

      Set reference climo file locations



   .. py:method:: get_timeseries_file(case, field)

      Return list of test time series files



   .. py:method:: get_ref_timeseries_file(field)

      Return list of reference time series files



   .. py:method:: load_timeseries_dataset(fils)

      Return DataSet from time series file(s) and assign time to midpoint of interval



   .. py:method:: load_timeseries_da(case, variablename)

      Return DataArray from time series file(s).
      Uses defaults file to convert units.



   .. py:method:: load_reference_timeseries_da(field)

      Return a DataArray time series to be used as reference
      (aka baseline) for variable field.



   .. py:method:: load_climo_da(case, variablename)

      Return DataArray from climo file



   .. py:method:: load_climo_file(case, variablename)

      Return Dataset for climo of variablename



   .. py:method:: get_climo_file(case, variablename)

      Retrieve the climo file path(s) for variablename for a specific case.



   .. py:method:: load_reference_climo_da(case, variablename)

      Return DataArray from reference (aka baseline) climo file



   .. py:method:: get_reference_climo_file(var)

      Return a list of files to be used as reference (aka baseline) for variable var.



   .. py:method:: get_regrid_file(case, field)

      Return list of test regridded files



   .. py:method:: load_regrid_dataset(case, field)

      Return a data set to be used as reference (aka baseline) for variable field.



   .. py:method:: load_regrid_da(case, field)

      Return a data array to be used as reference (aka baseline) for variable field.



   .. py:method:: get_ref_regrid_file(case, field)

      Return list of reference regridded files



   .. py:method:: load_reference_regrid_dataset(case, field)

      Return a data set to be used as reference (aka baseline) for variable field.



   .. py:method:: load_reference_regrid_da(case, field)

      Return a data array to be used as reference (aka baseline) for variable field.



   .. py:method:: load_dataset(fils)

      Return xarray DataSet from file(s)



   .. py:method:: load_da(fils, variablename, **kwargs)

      Return xarray DataArray from files(s) w/ optional scale factor, offset, and/or new units



   .. py:method:: get_value_converters(case, variablename)

      Get variable defaults if applicable

         - This is to get any scale factors or off-sets

      :returns: add_offset - int/float
                scale_factor - int/float