hydro.accessors

Module Contents

Classes

FQPointKey
FQProfileKey
WHPIndxer
CCHDOAccessor

Functions

write_or_return(data[, path_or_fobj])
normalize_fq(fq, *[, check_dupes])
fq_get_precisions(fq)

Attributes

FLAG_NAME
ERROR_NAME
PathType
NormalizedFQ
FTypeOptions

hydro.accessors.FLAG_NAME = 'cchdo.hydro._qc'

hydro.accessors.ERROR_NAME = 'cchdo.hydro._error'

hydro.accessors.PathType

hydro.accessors.write_or_return(data, path_or_fobj=None)

Parameters:

• data (bytes)

• path_or_fobj (PathType | io.BufferedWriter | None)

Return type:

bytes | None

class hydro.accessors.FQPointKey

Bases: NamedTuple

expocode: str

station: str

cast: int

sample: str

class hydro.accessors.FQProfileKey

Bases: NamedTuple

expocode: str

station: str

cast: int

class hydro.accessors.WHPIndxer(obj)

Parameters:

obj (xarray.Dataset)

__getitem__(key)

Parameters:

key (FQProfileKey | FQPointKey)

hydro.accessors.NormalizedFQ

hydro.accessors.normalize_fq(fq, *, check_dupes=True)

Parameters:

fq (list[dict[str, str | float]])

Return type:

NormalizedFQ

hydro.accessors.fq_get_precisions(fq)

Parameters:

fq (NormalizedFQ)

Return type:

dict[str, int]

hydro.accessors.FTypeOptions

class hydro.accessors.CCHDOAccessor(xarray_obj)

Parameters:

xarray_obj (xarray.Dataset)

property __geo_interface__

The station positions as a MultiPoint geo interface.

See https://gist.github.com/sgillies/2217756

property track

A dict which can be dumped to json which conforms to the expected structure for the CCHDO website.

property file_type

date_names

time_names

to_mat(fname)

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.

to_coards(path=None)

to_woce(path=None)

to_sum(path=None)

NetCDF to WOCE sumfile maker.

This is missing some information that is not included anymore (wire out, height above bottom). It is especially lacking in including woce parameter IDs

static _gen_fname(expocode, station, cast, profile_type, profile_count=1, ftype='cf')

Parameters:

• expocode (str)

• station (str)

• cast (int)

• profile_type (hydro.exchange.FileType)

• profile_count (int)

• ftype (FTypeOptions)

Return type:

str

gen_fname(ftype='cf')

Generate a human friendly netCDF (or other output type) filename for this object.

Parameters:

ftype (FTypeOptions)

Return type:

str

compact_profile()

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

static cchdo_c_format_precision(c_format)

Parameters:

c_format (str)

Return type:

int | None

_make_params_units_line(params)

Parameters:

params (dict[cchdo.params.WHPName, xarray.DataArray])

static _whpname_from_attrs(attrs)

Return type:

list[cchdo.params.WHPName]

_make_ctd_headers(params)

Return type:

list[str]

_make_data_block(params)

Parameters:

params (dict[cchdo.params.WHPName, xarray.DataArray])

Return type:

list[str]

_get_comments()

to_whp_columns(compact=False)

Return type:

dict[cchdo.params.WHPName, xarray.DataArray]

to_exchange(path=None)

Convert a CCHDO CF netCDF dataset to exchange.

merge_fq(fq, *, check_flags=True)

Parameters:

fq (list[dict[str, str | float]])