ocmw.dataman.dataReaders module

These functions are aimed at simplifying the interrogation of NetCDF4 files.

netcdfGeneric

Base class for loading and interogating netCDF4 data files.

ww3

Class structure for reading the ResourceCode WW3 model output netCDF files.

ww3Mesh

Class structure for extracting the model mesh data from the a ResourceCode WW3 model output netCDF files that contains the mesh definition.

ssw_rs

Class structure for reading the Marine Scotland SSW model output netCDF files.

sswMesh

Class structure for extracting the model mesh data from the a Marine Scotland SSW model output netCDF files that contains the mesh definition.

wavebuoy

Class structure for reading the CMEMS formatted wavebuoy netCDF files.

emecwb

Class structure for reading the EMEC formatted wavebuoy netCDF files.

drifter

Class structure for reading the CMEMS formatted drifter netCDF files.

Functions to simplify the interrogation of NetCDF4 files.

class ocmw.dataman.dataReaders.netcdfGeneric(fileName)[source]

Bases: object

Base class for loading and interogating netCDF4 data files.

listGlobalAttr()[source]
hasGlobalAttr(attrName)[source]
getGlobalAttr(attrName)[source]
listDims()[source]
hasDim(dimName)[source]
getDim(dimName)[source]
listVars()[source]
hasVar(varName)[source]
listVarAttrs(varName)[source]
hasVarAttr(varName, attrName)[source]
getVarAttr(varName, attrName)[source]
getVarDimNames(varName)[source]
getVarDimSizes(varName)[source]
getVar(varName)[source]
updateVar(varName, vals)[source]
updateVarAttr(varName, varAttr, vals)[source]
updateGlobalAttr(attrName, val)[source]
class ocmw.dataman.dataReaders.ww3(fileName)[source]

Bases: netcdfGeneric

Class structure for reading the ResourceCode WW3 model output netCDF files.

getMetaData()[source]
getVar(varName)[source]
class ocmw.dataman.dataReaders.ww3Mesh(meshFile)[source]

Bases: object

Class structure for extracting the model mesh data from the a ResourceCode WW3 model output netCDF files that contains the mesh definition.

class ocmw.dataman.dataReaders.ssw_rs(fileName)[source]

Bases: netcdfGeneric

Class structure for reading the Marine Scotland SSW model output netCDF files.

getMetaData()[source]
getVar(varName)[source]
class ocmw.dataman.dataReaders.sswMesh(sswFile)[source]

Bases: object

Class structure for extracting the model mesh data from the a Marine Scotland SSW model output netCDF files that contains the mesh definition.

class ocmw.dataman.dataReaders.wavebuoy(fileName)[source]

Bases: netcdfGeneric

Class structure for reading the CMEMS formatted wavebuoy netCDF files.

getMetaData()[source]
getVar(varName)[source]
getQCVar(varName)[source]
getQCTimeseries(varName, varIndex)[source]
gapFillTimeseries(times, values)[source]
class ocmw.dataman.dataReaders.emecwb(fileName)[source]

Bases: netcdfGeneric

Class structure for reading the EMEC formatted wavebuoy netCDF files.

getMetaData()[source]
getVar(varName)[source]
getQCVar(varName)[source]
getQCTimeseries(varName, varIndex)[source]
gapFillTimeseries(times, values)[source]
class ocmw.dataman.dataReaders.drifter(fileName)[source]

Bases: netcdfGeneric

Class structure for reading the CMEMS formatted drifter netCDF files.

getMetaData()[source]
getVar(varName)[source]
getTrackCoverage()[source]
crossesDomain(domain: spatialCoverage)[source]
ocmw.dataman.dataReaders.is_masked(data)[source]
ocmw.dataman.dataReaders.get_nc_var(ncHnd, varName)[source]
ocmw.dataman.dataReaders.ncread(filename, varname)[source]
ocmw.dataman.dataReaders.ncwrite(filename, varname, var)[source]