Basement

Osdyn provides readers and tools that make diagnostics implementation easy and allow to share them with different data sources.

Readers

Readers of data files support NetCDF Climate and Forecast metadata convention but does not assume any specific information. In particular the COMODO convention (welcomed however) is not required.

The knowledge of the specificities of each NetCDF database is not mandatory as the user selects his variables of interest according to the osdyn nomenclature (osdyn key names). These generic variable names are used throughout the analyses. Such a design allows a generic implementation of diagnostics, regardless the data sources.

Osdyn key names

Key names are introduced into the datasets thanks to to_osdyn methods.

Please find below a table describing the variable relative to each key name.

Table of osdyn key names

key_names	standard_names	units
beta	meridional_derivative_of_coriolis_parameter	m-1 s-1
runoff	outgoing_water_volume_transport_along_river_channel	m3 s-1
runoff_flx	runoff_flux	kg m-2 s-1
h_t	model_sea_floor_depth_below_sea_level	m
h_u	model_sea_floor_depth_below_sea_level_at_u_location	m
h_v	model_sea_floor_depth_below_sea_level_at_v_location	m
h_smooth	smoothed_ground_level_altitude	m
temp	sea_water_temperature	degrees_celsius
temp_bot	sea_water_temperature_at_sea_floor	degrees_celsius
temp_insitu	sea_water_insitu_temperature	degrees_celsius
salt	sea_water_salinity	PSU
obs_temp_sfc	observed_sea_surface_temperature	degrees_celsius
temp_sfc	surface_temperature	degrees_celsius
salt_sfc	sea_surface_salinity	PSU
dens	sea_water_density	kg m-3
dens_pot	sea_water_potential_density	kg m-3
dens_sfc	sea_surface_density	kg m-3
dens_neutral	sea_water_neutral_density	kg m-3
sigmat	sea_water_sigma_t	kg m-3
sigmat_pot	sea_water_sigma_theta	kg m-3
sigmat_1000dbar	sea_water_potential_density_tosee	kg m-3
sigmat_ref2000dbar	sea_water_potential_density_tosee	kg m-3
sigma_ref3000dbar	sea_water_potential_density_tosee	kg m-3
sigma_ref4000dbar	sea_water_potential_density_tosee	kg m-3
n2	square_of_brunt_vaisala_frequency_in_sea_water	s-2
conduct	sea_water_electrical_conductivity	S m-1
soundspd	speed_of_sound_in_sea_water	m s-1
mld_dens	ocean_mixed_layer_thickness_defined_by_density_criterion	m
mld_sigmat	ocean_mixed_layer_thickness_defined_by_sigma_theta_criterion	m
mld_turb	mixed_layer_depth	m
mld_temp	ocean_mixed_layer_thickness_defined_by_temperature_criterion	m
ped	potential_energy_deficit	J m-2
ohc	ocean_heat_content	J
osc	ocean_salt_content	kg
cp	specific_heat_capacity	J K-1
mdt	mean_dynamic_topography	m
z_sfc	sea_surface_height_above_mean_sea_level	m
xcur_btrope	barotropic_sea_water_x_velocity	m s-1
ycur_btrope	barotropic_sea_water_y_velocity	m s-1
xcur_bcline	baroclinic_sea_water_x_velocity	m s-1
ycur_bcline	baroclinic_sea_water_y_velocity	m s-1
cur	sea_water_speed	m s-1
cur_dir	direction_of_sea_water_velocity	degrees
xcur	sea_water_x_velocity	m s-1
ycur	sea_water_y_velocity	m s-1
xcur_sfc	sea_surface_x_velocity	m s-1
ycur_sfc	sea_surface_y_velocity	m s-1
xcur_geos	sea_water_x_geostrophic_velocity	m s-1
ycur_geos	sea_water_y_geostrophic_velocity	m s-1
xcur_geos_sfc	sea_suface_x_geostrophic_velocity	m s-1
ycur_geos_sfc	sea_surface_y_geostrophic_velocity	m s-1
zcur	sea_water_z_velocity_at_w_location	m s-1
zcur_sc	sea_water_z_velocity_in_sigma_coordinates	s-1
ke	kinetic_energy	m2 s-2
eke	eddy_kinetic_energy	m2 s-2
mke	mean_kinetic_energy	m2 s-2
tke	turbulent_kinetic_energy	m2 s-2
eps	dissipation_rate_of_turbulent_kinetic_energy	m2 s-3
diffh_mtm_lap_t	ocean_momentum_xy_laplacian_diffusivity	m2 s-1
diffh_mtm_lap_f	ocean_momentum_xy_laplacian_diffusivity_at_f_location	m2 s-1
diffv_mtm	ocean_vertical_momentum_diffusivity_at_w_location	m2 s-1
diffv_tra	average_ocean_vertical_tracer_diffusivity	m2 s-1
water_height	water_height_above_bathymetry	m
z_sfc_mean	mean_sea_level_above_sea_floor_depth_at_lowest_astronomical_tide	m
rad_net_sfc_down	surface_net_averaged_downward_radiative_flux	W m-2
hf_net_sfc_down	averaged_downward_ground_heat_flux	W m-2
lw_net_sfc_down	surface_net_downward_longwave_flux	W m-2
sw_net_sfc_down	surface_net_downward_shortwave_flux	W m-2
lw_sfc	surface_upward_longwave_flux	W m-2
sw_sfc	surface_upward_shortwave_flux	W m-2
lw_sfc_down	surface_downward_longwave_flux	W m-2
sw_sfc_down	surface_downward_shortwave_flux	W m-2
lh_sfc	surface_latent_heat_flux	W m-2
sh_sfc	surface_sensible_heat_flux	W m-2
lh_sfc_down	surface_downward_latent_heat_flux	W m-2
sh_sfc_down	surface_downward_sensible_heat_flux	W m-2
evap_sfc_down	surface_lwe_thickness_of_water_evaporation_amount	m
evap	lwe_thickness_of_water_evaporation_amount	m
evap_flx	water_potential_evaporation_flux	kg m-2 s-1
precip_down	precipitation_amount	m
rain_sfc	surface_thickness_of_rainfall_amout	m
rain	thickness_of_rainfall_amout	m
water_flx	water_flux_into_ocean	m3 s-1
freshwater_flx	water_flux_into_sea_water_from_rivers	kg m-2 s-1
cdwaflux	concentration_dilution_water_flux	kg m-2 s-1
z_sfc_btrope	ocean_barotropic_height	m
temp_2m	air_potential_temperature_at_2_meters	degrees_celsius
q_2m	air_specific_humidity_at_2_meters	kg kg-1
hu_2m	air_relative_specific_humidity_at_2_meters
z0	surface_roughness_length	m
cd	surface_drag_coefficient_in_air
ch	surface_drag_coefficient_for_heat_in_air
ce	latent_heat_coefficient_in_air tosee
wnd	wind_speed	m s-1
wnddir	wind_to_direction	degrees
wnddir_from	wind_from_direction	degrees
xwnd	eastward_wind	m s-1
ywnd	northward_wind	m s-1
zwnd	upward_wind	m s-1
xwnd_sfc	sea_surface_eastward_wind	m s-1
ywnd_sfc	sea_surface_northward_wind	m s-1
pres	air_pressure	Pa
topheight	altitude_at_top_of_atmosphere_model	m
pa	surface_air_pressure	Pa
xwnd_10m	x_wind_at_10m	m s-1
ywnd_10m	y_wind_at_10m	m s-1
zwnd_10m	z_wind_at_10m	m s-1
toax	surface_eastward_stress	N m-2
toay	surface_northward_stress	N m-2
taox	surface_downward_eastward_stress	N m-2
taoy	surface_downward_northward_stress	N m-2
ast	air_sea_temperature_difference	K
hs	sea_surface_wave_significant_height	m
mssx	eastward_mean_square_slope
mssy	nortward_mean_square_slope
mss	mean_square_slope
lm	mean_wave_length	m
t0m1	sea_surface_wind_wave_mean_period_from_variance_spectral_density_inverse_frequency_moment	s
t02	sea_surface_wind_wave_mean_period_from_variance_spectral_density_second_frequency_moment	s
t01	sea_surface_wind_wave_mean_period_from_variance_spectral_density_frequency_moment	s
wbt	dominant_wave_breaking_probability
ef	power_spectral_density_of_surface_elevation	m2 s
dp	sea_surface_wave_peak_direction	degrees
tp	sea_surface_wave_peak_period	s
fp	sea_surface_wave_peak_frequency	s-1
th1p	sea_surface_wave_from_direction	degrees
spr	sea_surface_wave_directional_spread	degrees
th1m	sea_surface_wave_from_direction_frequency_spectrum	degrees
sth1m	sea_surface_wave_spreading_spectrum	degrees
th2m	sea_surface_wave_from_direction_frequency_spectrum_from_second_moments	degrees
sth2m	sea_surface_wave_spreading_spectrum_from_second_moments	degrees
wn	wave_numbers	m-1
phs0	sea_surface_wave_significant_height_partition_0	m
phs1	sea_surface_wave_significant_height_partition_1	m
phs2	sea_surface_wave_significant_height_partition_2	m
phs3	sea_surface_wave_significant_height_partition_3	m
ptp0	sea_surface_wave_period_at_variance_spectral_density_maximum_partition_0	s
ptp1	sea_surface_wave_period_at_variance_spectral_density_maximum_partition_1	s
ptp2	sea_surface_wave_period_at_variance_spectral_density_maximum_partition_2	s
ptp3	sea_surface_wave_period_at_variance_spectral_density_maximum_partition_3	s
wsf	wind_sea_fraction
cge	sea_surface_wind_wave_energy_flux	kW m-1
charnock	charnock_coefficient_for_surface_roughness_length_for_momentum_in_air
ust	friction_velocity	m s-1
uust	eastward_friction_velocity	m s-1
vust	northward_friction_velocity	m s-1
twa	wave_to_wind_stress	m2 s-2
utwa	eastward_wave_to_wind_stress	m2 s-2
vtwa	northward_wave_to_wind_stress	m2 s-2
wcc	whitecap_coverage
wcf	whitecap_foam_thickness	m
wch	significant_breaking_wave_height	m
ubr	rms_amplitude_of_orbital_bottom_velocity_of_wind_and_swell_waves	m s-1
uubr	rms_of_bottom_zonal_velocity_amplitude	m s-1
vubr	rms_of_bottom_meridional_velocity_amplitude	m s-1
abr	rms_of_bottom_displacement_amplitude	m
uabr	rms_of_bottom_displacement_amplitude_zonal	m
vabr	rms_of_bottom_displacement_amplitude_meridional	m
bhd	radiation_pressure	m2 s-2
foc	wave_to_ocean_energy_flux	W m-2
two	surface_wave_ocean_momentum_flux	m2 s-2
utwo	x_component_of_surface_wave_ocean_momentum_flux	m2 s-2
vtwo	y_component_of_surface_wave_ocean_momentum_flux	m2 s-2
faw	wind_mixing_energy_flux_into_sea_water	W m-2
taw	wave_supported_wind_stress	m2 s-2
utaw	x_component_of_wave_supported_wind_stress	m2 s-2
vtaw	y_component_of_wave_supported_wind_stress	m2 s-2
fbb	wave_energy_dissipation_in_bottom_boundary_layer	W m-2
tbb	bottom_wave_ocean_momentum_flux	m2 s-2
utbb	x_component_of_bottom_wave_ocean_momentum_flux	m2 s-2
vtbb	y_component_of_bottom_wave_ocean_momentum_flux	m2 s-2
uss	surface_stokes_drift	m s-1
uuss	eastward_surface_stokes_drift	m s-1
vuss	northward_surface_stokes_drift	m s-1
tus	stokes_transport	m2 s-1
utus	eastward_stokes_transport	m2 s-1
vtus	northward_stokes_transport	m2 s-1
mapsta	status_map
tws	wind_sea_mean_period_t0m1	s
sxx	radiation_stress_component_sxx	N m-1
syy	radiation_stress_component_syy	N m-1
sxy	radiation_stress_component_sxy	N m-1

Sample selection

In order to reduce memory usage, sub-domains and periods are selected as soon as the dataset is read.

Parallelization

TODO

Diagnostics

Many generic functions adress the estimate of the main oceanographic features. They are depicted in the osdyn.diags part of the API.

Plots

Although osdyn is not dedicated to plotting, many figures are available throughout the Gallery. They are static when based on matplotlib and cartopy modules but interactive when using the plotly package.