hydro.accessors
#
Module Contents#
Classes#
Class base for CCHDO accessors |
|
Accessor containing the experimental matlab machinery |
|
Accessor containing legacy format outputs (coards, woce) |
|
Accessor providing geo_interface machinery |
|
Accessor with misc functions that don't fit in some other category |
|
Class containing the to_exchange functionn |
|
Class base for CCHDO accessors |
|
Collect all the accessors into a single class |
Functions#
|
Attributes#
- hydro.accessors.write_or_return(data, path_or_fobj=None)[source]#
- Parameters:
data (bytes) –
path_or_fobj (Optional[Union[PathType, io.BufferedWriter]]) –
- Return type:
Optional[bytes]
- class hydro.accessors.CCHDOAccessorBase(xarray_obj)[source]#
Class base for CCHDO accessors
saves the xarray object to self._obj for all the subclasses
- Parameters:
xarray_obj (Union[xarray.DataArray, xarray.Dataset]) –
- class hydro.accessors.MatlabAccessor(xarray_obj)[source]#
Bases:
CCHDOAccessorBase
Accessor containing the experimental matlab machinery
- Parameters:
xarray_obj (Union[xarray.DataArray, xarray.Dataset]) –
- to_mat(fname)[source]#
Experimental Matlab .mat data file generator
The support for netCDF files in Matlab is really bad. Matlab also has no built in support for the standards we are trying to follow (CF, ACDD), the most egregious lack of support is how to deal with times in netCDF files. This was an attempt to make a mat file which takes care of some of the things matlab won’t do for you. It requires scipy to function.
The file it produces is in no way stable.
- class hydro.accessors.LegacyFormatAccessor(xarray_obj)[source]#
Bases:
CCHDOAccessorBase
Accessor containing legacy format outputs (coards, woce)
- Parameters:
xarray_obj (Union[xarray.DataArray, xarray.Dataset]) –
- class hydro.accessors.GeoAccessor(xarray_obj)[source]#
Bases:
CCHDOAccessorBase
Accessor providing geo_interface machinery
- Parameters:
xarray_obj (Union[xarray.DataArray, xarray.Dataset]) –
- class hydro.accessors.MiscAccessor(xarray_obj)[source]#
Bases:
CCHDOAccessorBase
Accessor with misc functions that don’t fit in some other category
- Parameters:
xarray_obj (Union[xarray.DataArray, xarray.Dataset]) –
- gen_fname(ftype='cf')[source]#
Generate a human friendly netCDF filename for this object
- Return type:
- compact_profile()[source]#
Drop the trailing empty data from a profile.
Because we use the incomplete multidimensional array representation of profiles there is often “wasted space” at the end of any profile that is not the longest one. This accessor drops that wasted space for xr.Dataset objects containing a single profile
- class hydro.accessors.ExchangeAccessor(xarray_obj)[source]#
Bases:
CCHDOAccessorBase
Class containing the to_exchange functionn
- Parameters:
xarray_obj (Union[xarray.DataArray, xarray.Dataset]) –
- _make_params_units_line(params)[source]#
- Parameters:
params (Dict[cchdo.params.WHPName, xarray.DataArray]) –
- class hydro.accessors.WHPIndxer(obj)[source]#
- Parameters:
obj (xarray.Dataset) –
- class hydro.accessors.MergeFQAccessor(xarray_obj)[source]#
Bases:
CCHDOAccessorBase
Class base for CCHDO accessors
saves the xarray object to self._obj for all the subclasses
- Parameters:
xarray_obj (Union[xarray.DataArray, xarray.Dataset]) –
- class hydro.accessors.CCHDOAccessor(xarray_obj)[source]#
Bases:
ExchangeAccessor
,GeoAccessor
,LegacyFormatAccessor
,MatlabAccessor
,MiscAccessor
,MergeFQAccessor
Collect all the accessors into a single class
- Parameters:
xarray_obj (Union[xarray.DataArray, xarray.Dataset]) –