Function reference • nemomedusR

Interface

The user interface which wraps the summarisers below.

NEMO_MEDUSA(): Condense NEMO MEDUSA Model Outputs into a Summary file

Summarisers

Extractors

Functions to pull variables from model output files.

get_grid_T_slabR() get_ptrc_T_slabR() get_grid_W_slabR() get_grid_V_slabR() get_grid_U_slabR() get_icemod_slabR(): Extract summaries from NEMO-MEDUSA arrays using slabR

get_grid_T_1D() get_ptrc_T_1D() get_grid_W_1D() get_grid_V_1D() get_grid_U_1D(): Extract a 1D water column from NEMO-MEDUSA

get_grid_T_StrathE2E() get_ptrc_T_StrathE2E() get_icemod_StrathE2E() get_grid_W_StrathE2E() get_grid_V_StrathE2E() get_grid_U_StrathE2E(): DEPRECATED. Extract a StrathE2E summary from NEMO-MEDUSA These functions read in target variables from NEMO-MEDUSA model outputs and return a summarised slab.

Schemes

Functions to create common slabR summary schemes.

scheme_strathE2E(): Return a slabR Scheme for a StrathE2E Summary

scheme_interp_slice(): Return a slabR Scheme for Linear Interpolation Between Array Slices

scheme_column(): Return a slabR Scheme for a StrathE2E Summary

scheme_to_start() scheme_to_count() scheme_reframe(): Use slabR Schemes with netcdf Files

Averaging

Average the pulled variables to user specifications.

array_w_mean(): Index based weighted means from arrays in C++

stratify(): Summarise Across Depths in a NEMO-MEDUSA Array

temporal_operation(): Perform Temporal Summary Operations Within `NEMO-MEDUSA` by Model Output File Type

Spatial utilities

Handle spatial weighting for averages, depth layers, and map projections.

calculate_depth_share(): Calculate Water Layer Thicknesses Within a Vector

calculate_proximity_weight(): Calculate the Weights for Linear Interpolation Between Two Depths

get_spatial(): Get Latitudes, Longitudes, & Depths From NEMO-MEDUSA Model Outputs

xyindex_to_nindex(): Convert XY coordinates to a value index for a matrix

voronoi_grid(): Calculate the Domain Area per Grid Point