lib.adf_dataset module

class lib.adf_dataset.AdfData(adfobj)[source]

Bases: object

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.

get_climo_file(case, variablename)[source]

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

get_ref_regrid_file(case, field)[source]

Return list of reference regridded files

get_ref_timeseries_file(field)[source]

Return list of reference time series files

get_reference_climo_file(var)[source]

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

get_regrid_file(case, field)[source]

Return list of test regridded files

get_timeseries_file(case, field)[source]

Return list of test time series files

get_value_converters(case, variablename)[source]

Get variable defaults if applicable

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

Returns:

add_offset - int/float scale_factor - int/float

load_climo_da(case, variablename)[source]

Return DataArray from climo file

load_climo_file(case, variablename)[source]

Return Dataset for climo of variablename

load_da(fils, variablename, **kwargs)[source]

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

load_dataset(fils)[source]

Return xarray DataSet from file(s)

load_reference_climo_da(case, variablename)[source]

Return DataArray from reference (aka baseline) climo file

load_reference_regrid_da(case, field)[source]

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

load_reference_regrid_dataset(case, field)[source]

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

load_reference_timeseries_da(field)[source]

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

load_regrid_da(case, field)[source]

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

load_regrid_dataset(case, field)[source]

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

load_timeseries_da(case, variablename)[source]

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

load_timeseries_dataset(fils)[source]

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

set_ref_var_loc()[source]

Set reference climo file locations

set_reference()[source]

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

lib.adf_dataset.my_formatwarning(msg, *args, **kwargs)[source]