API.rst

Public Function Reference

Approximately Neutral Surfaces

Potential Density Surface

neutralocean.surface.isopycnal.potential_surf

Specific Volume Anomaly Surface

neutralocean.surface.isopycnal.anomaly_surf

Omega Surface

neutralocean.surface.omega.omega_surf

Grids

Rectilinear

neutralocean.grid.rectilinear.build_grid

neutralocean.grid.rectilinear.edgedata_to_maps

xgcm (tiled rectilinear)

neutralocean.grid.xgcm.build_grid

neutralocean.grid.xgcm.edgedata_to_maps

tripolar

neutralocean.grid.tripolar.build_grid

neutralocean.grid.tripolar.edgedata_to_maps

Graph

neutralocean.grid.graph.build_grid

neutralocean.grid.graph.edges_to_graph

neutralocean.grid.graph.graph_binary_fcn

Neutrality Error

neutralocean.ntp.ntp_epsilon_errors

neutralocean.ntp.ntp_epsilon_errors_norms

Neutral Trajectory

neutralocean.traj.ntp_bottle_to_cast

neutralocean.traj.neutral_trajectory

Veronis Density

neutralocean.label.veronis_density

Mixed Layer

neutralocean.mixed_layer.mixed_layer

Equation Of State

Tools

neutralocean.eos.tools.make_eos

neutralocean.eos.tools.make_eos_s_t

neutralocean.eos.tools.make_eos_p

neutralocean.eos.tools.vectorize_eos

JMD95

neutralocean.eos.jmd95

neutralocean.eos.jmd95.rho

neutralocean.eos.jmd95.rho_s_t

neutralocean.eos.jmd95.rho_p

JMDFWG06

neutralocean.eos.jmdfwg06

neutralocean.eos.jmdfwg06.rho

neutralocean.eos.jmdfwg06.rho_s_t

neutralocean.eos.jmdfwg06.rho_p

TEOS-10 GSW

neutralocean.eos.gsw

neutralocean.eos.gsw.specvol

neutralocean.eos.gsw.specvol_s_t

neutralocean.eos.gsw.specvol_p

neutralocean.eos.gsw.specvol_s_t_ss_st_tt_sp_tp

neutralocean.eos.gsw.specvol_s_t_ss_st_tt_sp_tp_sss_sst_stt_ttt_ssp_stp_ttp_spp_tpp

(Vertical) Interpolation using Piecewise Polynomials (PP)

neutralocean.ppinterp.__init__

neutralocean.ppinterp.tools.make_pp

neutralocean.ppinterp.ppval

neutralocean.ppinterp.ppval_1

neutralocean.ppinterp.ppval_two

neutralocean.ppinterp.ppval_1_two

neutralocean.ppinterp.linear.linear_interp

neutralocean.ppinterp.linear.linear_interp_1

neutralocean.ppinterp.linear.linear_coeffs

neutralocean.ppinterp.linear.linear_coeffs_1

neutralocean.ppinterp.linear.linear_interp_two

neutralocean.ppinterp.linear.linear_interp_1_two

neutralocean.ppinterp.pchip.pchip_interp

neutralocean.ppinterp.pchip.pchip_interp_1

neutralocean.ppinterp.pchip.pchip_coeffs

neutralocean.ppinterp.pchip.pchip_coeffs_1

neutralocean.ppinterp.pchip.pchip_coeffs_1_nonan

neutralocean.ppinterp.pchip.pchip_interp_two

neutralocean.ppinterp.pchip.pchip_interp_1_two

Synthetic Ocean

neutralocean.synthocean.synthocean