API Documentation

API Documentation#

DiagnosticOutputAltimetry#

class fmdap.diagnostic_output_altimetry.DiagnosticOutputAltimetry(file_diag, file_obs, obs_col_name='adt_dhi')#

read_mesh(file_mesh)#

Read diagnostic output dfs0 file, determine type and store as data frame

Parameters:: file (filename -- path to the dfs0)

EnsembleOutput#

AR1#

fmdap.AR1.estimate_AR1_halflife(df)#: Estimate AR(1) half-life of columns in DataFrame

fmdap.AR1.halflife_to_phi(rho, dt=1)#: Convert half-life to the AR(1) propagation parameter phi

fmdap.AR1.phi_to_halflife(phi, dt=1.0)#: Convert the AR(1) propagation parameter phi to half-life

Spatial#

fmdap.spatial.fit_gaussian(x, values, max_dist=None)#: Fit the Gaussian distance function to data

fmdap.spatial.gaussian(x, spatial_corr)#: Gaussian distance function with value 1 at 0 and zero mean

fmdap.spatial.get_distance_and_corrcoef(dfs, item=0, n_sample=100)#: Calculate pairwise distances and correlations from sample of point in dfs file

Pfs#

class fmdap.pfs.Pfs(pfs_file: str | Path)#

property dda#: Dictionary of settings in DATA_ASSIMILATION_MODULE

property diagnostics#: DataFrame with diagnostic outputs

property measurement_positions#: DataFrame with measurement positions

property measurements#: DataFrame with measurements

property model_errors#: DataFrame with model errors

property sections#: List of the DA Pfs sections

classmethod validate_positions(mesh, df)#: Determine if positions are inside mesh and find nearest cell centers