Index

A

add_forcing_data() (pyfvcom2.nest.NestManager method) add_grid() (pyfvcom2.tide.HarmonicAnalysisWriter method) add_grid_band() (pyfvcom2.nest.Nest method) add_harmonics() (pyfvcom2.tide.HarmonicAnalysisWriter method) add_interpolator() (pyfvcom2.tide.TideManager method) add_nest() (pyfvcom2.nest.NestManager method) add_predicted() (pyfvcom2.tide.HarmonicAnalysisWriter method) add_raw() (pyfvcom2.tide.HarmonicAnalysisWriter method) add_tidal_data() (pyfvcom2.nest.NestManager method) (pyfvcom2.obc.OBCManager method)

add_variable() (pyfvcom2.fvcom_writer.FVCOMWriter method) amplitude_var_name (pyfvcom2.tide_reader.FVCOMHarmonicsNames attribute) (pyfvcom2.tide_reader.TPXOHarmonicsNames attribute) amplitudes (pyfvcom2.tide_reader.HarmonicsData attribute) analyse_harmonics() (in module pyfvcom2.tide) apply_ramp() (pyfvcom2.nest.NestManager method) apply_transport_unit_conversion (pyfvcom2.tide_reader.FVCOMHarmonicsNames attribute) (pyfvcom2.tide_reader.TPXOComplexHarmonicsNames attribute) (pyfvcom2.tide_reader.TPXOHarmonicsNames attribute)

B

bathy_elements (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property) bathy_nodes (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property) bathy_var_name (pyfvcom2.tide_reader.FVCOMHarmonicsNames attribute) (pyfvcom2.tide_reader.TPXOComplexHarmonicsNames attribute) (pyfvcom2.tide_reader.TPXOHarmonicsNames attribute)

BathymetrySmoother (class in pyfvcom2.bathy_smoother) bdy_id (pyfvcom2.grid.OpenBoundary property) build_fvcom_grid() (in module pyfvcom2.grid_builder)

C

calculate_weights() (pyfvcom2.weights_calculator.ExponentialWeightsCalculator method) (pyfvcom2.weights_calculator.LinearWeightsCalculator method) (pyfvcom2.weights_calculator.WeightsCalculator method) cart2pol() (in module pyfvcom2.coordinates) clear_nests() (pyfvcom2.nest.NestManager method) close() (pyfvcom2.cmems_reader.CMEMSReader method) cm2inch() (in module pyfvcom2.plotting) (in module pyfvcom2.plotting.plot) CMEMSInterpolator (class in pyfvcom2.interpolation) CMEMSPlotter (class in pyfvcom2.plotting) (class in pyfvcom2.plotting.plot) CMEMSReader (class in pyfvcom2.cmems_reader) colourmap() (in module pyfvcom2.plotting) (in module pyfvcom2.plotting.plot) cond2salt() (in module pyfvcom2.ocean)

connectivity() (in module pyfvcom2.grid) constituents (pyfvcom2.tide.TideManager property) (pyfvcom2.tide_reader.HarmonicsData attribute) constituents_var_name (pyfvcom2.tide_reader.FVCOMHarmonicsNames attribute) (pyfvcom2.tide_reader.TPXOComplexHarmonicsNames attribute) (pyfvcom2.tide_reader.TPXOHarmonicsNames attribute) contains_date() (pyfvcom2.cmems_reader.CMEMSReader method) cp_sw() (in module pyfvcom2.ocean) create_cbar_ax() (in module pyfvcom2.plotting) (in module pyfvcom2.plotting.plot) create_datetime_array() (in module pyfvcom2.date_utils) create_figure() (in module pyfvcom2.plotting) (in module pyfvcom2.plotting.plot) create_forcing_file() (pyfvcom2.nest.NestManager method) (pyfvcom2.obc.OBCManager method)

D

dates (pyfvcom2.cmems_reader.CMEMSReader property) (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.interpolation.InterpolationCoordinates property) (pyfvcom2.interpolation_coordinates.InterpolationCoordinates property) DAYS_PER_MILLISECOND (pyfvcom2.fvcom_reader.FVCOMReader attribute) dens_jackett() (in module pyfvcom2.ocean) depth2pressure() (in module pyfvcom2.ocean)

depth_levels (pyfvcom2.cmems_reader.CMEMSReader property) dissipation() (in module pyfvcom2.ocean) dl (pyfvcom2.sigma.SigmaConfig attribute) draw_grid() (pyfvcom2.plotting.FVCOMPlotter method) (pyfvcom2.plotting.plot.FVCOMPlotter method) dT_adiab_sw() (in module pyfvcom2.ocean) du (pyfvcom2.sigma.SigmaConfig attribute)

E

element_weights (pyfvcom2.nest.GridBand property) elements (pyfvcom2.nest.GridBand property)

ExponentialWeightsCalculator (class in pyfvcom2.weights_calculator) extend_datetime_array() (in module pyfvcom2.tide)

F

filter() (pyfvcom2.lanczos.LanczosFilter method) find_connected_elements() (in module pyfvcom2.grid) find_file() (in module pyfvcom2.file_utils) find_files() (in module pyfvcom2.file_utils) FVCOMHarmonicsNames (class in pyfvcom2.tide_reader)

FVCOMHarmonicsReader (class in pyfvcom2.tide_reader) FVCOMInterpolator (class in pyfvcom2.interpolation) FVCOMPlotter (class in pyfvcom2.plotting) (class in pyfvcom2.plotting.plot) FVCOMReader (class in pyfvcom2.fvcom_reader) FVCOMWriter (class in pyfvcom2.fvcom_writer)

G

generate_land_sea_mask() (pyfvcom2.interpolation.FVCOMInterpolator method) get_all_element_weights() (pyfvcom2.nest.NestManager method) get_all_nest_elements() (pyfvcom2.nest.NestManager method) get_all_nest_nodes() (pyfvcom2.nest.NestManager method) get_all_node_weights() (pyfvcom2.nest.NestManager method) get_bottom_indices() (pyfvcom2.cmems_reader.CMEMSReader method) get_closest_date_index() (pyfvcom2.cmems_reader.CMEMSReader method) get_epsg_code() (in module pyfvcom2.coordinates) get_filled_2D_var() (pyfvcom2.cmems_reader.CMEMSReader method) get_filled_3D_var() (pyfvcom2.cmems_reader.CMEMSReader method) get_filled_3D_var_by_index() (pyfvcom2.cmems_reader.CMEMSReader method) get_forcing_data() (pyfvcom2.nest.NestManager method) get_grid_bands() (pyfvcom2.nest.Nest method) get_interpolation_coordinates() (pyfvcom2.fvcom_reader.FVCOMReader method) (pyfvcom2.grid.Grid method) (pyfvcom2.nest.NestManager method) get_mask() (pyfvcom2.cmems_reader.CMEMSReader method)

get_n_depth_levels() (pyfvcom2.fvcom_reader.FVCOMReader method) get_nests() (pyfvcom2.nest.NestManager method) get_sigma_levels() (pyfvcom2.fvcom_reader.FVCOMReader method) get_tidal_data() (pyfvcom2.nest.NestManager method) get_time_dep_z_levels() (pyfvcom2.fvcom_reader.FVCOMReader method) get_unmasked_var_by_index() (pyfvcom2.cmems_reader.CMEMSReader method) get_unmasked_variable() (pyfvcom2.cmems_reader.CMEMSReader method) get_var() (pyfvcom2.cmems_reader.CMEMSReader method) (pyfvcom2.fvcom_reader.FVCOMReader method) get_var_by_index() (pyfvcom2.cmems_reader.CMEMSReader method) get_var_dimensions() (pyfvcom2.fvcom_reader.FVCOMReader method) get_var_ndims() (pyfvcom2.cmems_reader.CMEMSReader method) get_vertical_position() (pyfvcom2.fvcom_reader.FVCOMReader method) get_weights_calculator() (in module pyfvcom2.weights_calculator) GlobalBathymetrySmoother (class in pyfvcom2.bathy_smoother) Grid (class in pyfvcom2.grid) grid (pyfvcom2.fvcom_reader.FVCOMReader property) GridBand (class in pyfvcom2.nest)

H

HarmonicAnalysisWriter (class in pyfvcom2.tide) HarmonicsAnalyser (class in pyfvcom2.tide) HarmonicsData (class in pyfvcom2.tide_reader)

HarmonicsReader (class in pyfvcom2.tide_reader) horizontal_coordinate_system (pyfvcom2.interpolation.InterpolationCoordinates property) (pyfvcom2.interpolation_coordinates.InterpolationCoordinates property) hybrid_sigma_coordinate() (in module pyfvcom2.sigma)

I

interpolate() (pyfvcom2.interpolation.CMEMSInterpolator method) (pyfvcom2.interpolation.FVCOMInterpolator method) (pyfvcom2.interpolation.Interpolator method) (pyfvcom2.interpolation.TPXOInterpolator method)

InterpolationCoordinates (class in pyfvcom2.interpolation) (class in pyfvcom2.interpolation_coordinates) Interpolator (class in pyfvcom2.interpolation)

K

kl (pyfvcom2.sigma.SigmaConfig attribute)

ku (pyfvcom2.sigma.SigmaConfig attribute)

L

lanczos() (in module pyfvcom2.lanczos) LanczosFilter (class in pyfvcom2.lanczos) lat_elements (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property) lat_nodes (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property) lat_var_name (pyfvcom2.tide_reader.FVCOMHarmonicsNames attribute) (pyfvcom2.tide_reader.TPXOComplexHarmonicsNames attribute) (pyfvcom2.tide_reader.TPXOHarmonicsNames attribute) latitude (pyfvcom2.tide_reader.HarmonicsData attribute) lats (pyfvcom2.cmems_reader.CMEMSReader property) lats_2D (pyfvcom2.cmems_reader.CMEMSReader property)

LinearWeightsCalculator (class in pyfvcom2.weights_calculator) lon_elements (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property) lon_nodes (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property) lon_var_name (pyfvcom2.tide_reader.FVCOMHarmonicsNames attribute) (pyfvcom2.tide_reader.TPXOComplexHarmonicsNames attribute) (pyfvcom2.tide_reader.TPXOHarmonicsNames attribute) longitude (pyfvcom2.tide_reader.HarmonicsData attribute) lonlat_from_utm() (in module pyfvcom2.coordinates) lons (pyfvcom2.cmems_reader.CMEMSReader property) lons_2D (pyfvcom2.cmems_reader.CMEMSReader property)

M

make_nests() (pyfvcom2.nest.NestManager method) MeshData (class in pyfvcom2.mesh_reader) min_constant_depth (pyfvcom2.sigma.SigmaConfig attribute) mixedlayerdepth() (in module pyfvcom2.ocean) module pyfvcom2.bathy_smoother pyfvcom2.cmems_reader pyfvcom2.coordinates pyfvcom2.date_utils pyfvcom2.exceptions pyfvcom2.file_utils pyfvcom2.fvcom_reader pyfvcom2.fvcom_writer pyfvcom2.grid pyfvcom2.grid_builder pyfvcom2.interpolation pyfvcom2.interpolation_coordinates pyfvcom2.lanczos pyfvcom2.mesh_reader pyfvcom2.namelist pyfvcom2.nest pyfvcom2.obc pyfvcom2.ocean pyfvcom2.plotting pyfvcom2.plotting.plot pyfvcom2.restart pyfvcom2.sigma pyfvcom2.tide pyfvcom2.tide_reader pyfvcom2.weights_calculator

N

n_depths (pyfvcom2.cmems_reader.CMEMSReader property) n_elements (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property) n_files (pyfvcom2.cmems_reader.CMEMSReader property) n_nodes (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property) n_open_boundaries (pyfvcom2.grid.Grid property) n_sigma_layers (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property) n_sigma_levels (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property)

NamelistManager (class in pyfvcom2.namelist) Nest (class in pyfvcom2.nest) NestManager (class in pyfvcom2.nest) nlev (pyfvcom2.sigma.SigmaConfig attribute) nnodes (pyfvcom2.grid.OpenBoundary property) node_indices (pyfvcom2.grid.OpenBoundary property) node_weights (pyfvcom2.nest.GridBand property) nodes (pyfvcom2.mesh_reader.MeshData attribute) (pyfvcom2.nest.GridBand property) nodes2elems() (in module pyfvcom2.grid) nodes_bdy (pyfvcom2.grid.Grid property) (pyfvcom2.mesh_reader.MeshData attribute)

O

OBCManager (class in pyfvcom2.obc)

OpenBoundary (class in pyfvcom2.grid)

P

parse_obc_sections() (in module pyfvcom2.mesh_reader) part1_var_name (pyfvcom2.tide_reader.TPXOComplexHarmonicsNames attribute) part2_var_name (pyfvcom2.tide_reader.TPXOComplexHarmonicsNames attribute) pea() (in module pyfvcom2.ocean) phase_var_name (pyfvcom2.tide_reader.FVCOMHarmonicsNames attribute) (pyfvcom2.tide_reader.TPXOHarmonicsNames attribute) phases (pyfvcom2.tide_reader.HarmonicsData attribute) plot_field() (pyfvcom2.plotting.CMEMSPlotter method) (pyfvcom2.plotting.FVCOMPlotter method) (pyfvcom2.plotting.plot.CMEMSPlotter method) (pyfvcom2.plotting.plot.FVCOMPlotter method) (pyfvcom2.plotting.plot.PyFVCOM2Plotter method) (pyfvcom2.plotting.PyFVCOM2Plotter method) plot_lines() (pyfvcom2.plotting.plot.PyFVCOM2Plotter method) (pyfvcom2.plotting.PyFVCOM2Plotter method) plot_quiver() (pyfvcom2.plotting.FVCOMPlotter method) (pyfvcom2.plotting.plot.FVCOMPlotter method) pol2cart() (in module pyfvcom2.coordinates) predict() (pyfvcom2.tide.TideManager method) predict_tide() (in module pyfvcom2.tide) pressure2depth() (in module pyfvcom2.ocean) process_sigma_config() (in module pyfvcom2.sigma) pyfvcom2.bathy_smoother module pyfvcom2.cmems_reader module pyfvcom2.coordinates module pyfvcom2.date_utils module pyfvcom2.exceptions module pyfvcom2.file_utils module pyfvcom2.fvcom_reader module pyfvcom2.fvcom_writer module pyfvcom2.grid module

pyfvcom2.grid_builder module pyfvcom2.interpolation module pyfvcom2.interpolation_coordinates module pyfvcom2.lanczos module pyfvcom2.mesh_reader module pyfvcom2.namelist module pyfvcom2.nest module pyfvcom2.obc module pyfvcom2.ocean module pyfvcom2.plotting module pyfvcom2.plotting.plot module pyfvcom2.restart module pyfvcom2.sigma module pyfvcom2.tide module pyfvcom2.tide_reader module pyfvcom2.weights_calculator module PyFVCOM2AttributeError PyFVCOM2Exception PyFVCOM2FileNotFoundError PyFVCOM2Plotter (class in pyfvcom2.plotting) (class in pyfvcom2.plotting.plot) PyFVCOM2RuntimeError PyFVCOM2TypeError PyFVCOM2ValueError

R

r_factor() (pyfvcom2.bathy_smoother.BathymetrySmoother method) read_fvcom_mesh() (in module pyfvcom2.mesh_reader) read_fvcom_obc() (in module pyfvcom2.mesh_reader) read_gmsh_mesh() (in module pyfvcom2.mesh_reader) read_harmonics() (pyfvcom2.tide_reader.FVCOMHarmonicsReader method) (pyfvcom2.tide_reader.HarmonicsReader method) (pyfvcom2.tide_reader.TPXOComplexHarmonicsReader method) (pyfvcom2.tide_reader.TPXOHarmonicsReader method) read_mesh_file() (in module pyfvcom2.mesh_reader)

read_mike_mesh() (in module pyfvcom2.mesh_reader) read_sigma_file() (in module pyfvcom2.sigma) read_smesh_mesh() (in module pyfvcom2.mesh_reader) read_sms_mesh() (in module pyfvcom2.mesh_reader) reconstruct_wrapper() (in module pyfvcom2.tide) remove_line_plots() (pyfvcom2.plotting.plot.PyFVCOM2Plotter method) (pyfvcom2.plotting.PyFVCOM2Plotter method) rhum() (in module pyfvcom2.ocean) round_time() (in module pyfvcom2.date_utils) run() (pyfvcom2.tide.HarmonicsAnalyser method)

S

scatter() (pyfvcom2.plotting.CMEMSPlotter method) (pyfvcom2.plotting.FVCOMPlotter method) (pyfvcom2.plotting.plot.CMEMSPlotter method) (pyfvcom2.plotting.plot.FVCOMPlotter method) (pyfvcom2.plotting.plot.PyFVCOM2Plotter method) (pyfvcom2.plotting.PyFVCOM2Plotter method) set_bed_roughness() (pyfvcom2.grid.Grid method) set_dates() (pyfvcom2.nest.NestManager method) (pyfvcom2.obc.OBCManager method) set_sponge() (pyfvcom2.grid.OpenBoundary method) set_title() (pyfvcom2.plotting.plot.PyFVCOM2Plotter method) (pyfvcom2.plotting.PyFVCOM2Plotter method) sigma_config (pyfvcom2.grid.Grid property) (pyfvcom2.sigma.SigmaData attribute) sigma_generalized() (in module pyfvcom2.sigma) sigma_geometric() (in module pyfvcom2.sigma) sigma_layers (pyfvcom2.grid.Grid property) (pyfvcom2.grid.OpenBoundary property) sigma_layers_elements (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property) sigma_layers_nodes (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property) sigma_levels (pyfvcom2.grid.Grid property) (pyfvcom2.grid.OpenBoundary property) (pyfvcom2.sigma.SigmaData attribute)

sigma_levels_elements (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property) sigma_levels_nodes (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property) sigma_tanh() (in module pyfvcom2.sigma) sigma_to_z_coords() (in module pyfvcom2.coordinates) sigmac_layers (pyfvcom2.grid.Grid property) sigmac_levels (pyfvcom2.grid.Grid property) SigmaConfig (class in pyfvcom2.sigma) SigmaData (class in pyfvcom2.sigma) sigpow (pyfvcom2.sigma.SigmaConfig attribute) sigtype (pyfvcom2.sigma.SigmaConfig attribute) simpsonhunter() (in module pyfvcom2.ocean) smooth() (pyfvcom2.bathy_smoother.BathymetrySmoother method) (pyfvcom2.bathy_smoother.GlobalBathymetrySmoother method) sponge_coefficient (pyfvcom2.grid.OpenBoundary property) sponge_radius (pyfvcom2.grid.OpenBoundary property) stokes() (in module pyfvcom2.ocean) sw_dens() (in module pyfvcom2.ocean) sw_dens0() (in module pyfvcom2.ocean) sw_sal78() (in module pyfvcom2.ocean) sw_sal80() (in module pyfvcom2.ocean) sw_salinity() (in module pyfvcom2.ocean) sw_seck() (in module pyfvcom2.ocean) sw_smow() (in module pyfvcom2.ocean) sw_svan() (in module pyfvcom2.ocean)

T

theta_sw() (in module pyfvcom2.ocean) TideManager (class in pyfvcom2.tide) time_span (pyfvcom2.cmems_reader.CMEMSReader property) TPXOComplexHarmonicsNames (class in pyfvcom2.tide_reader) TPXOComplexHarmonicsReader (class in pyfvcom2.tide_reader) TPXOHarmonicsNames (class in pyfvcom2.tide_reader) TPXOHarmonicsReader (class in pyfvcom2.tide_reader) TPXOInterpolator (class in pyfvcom2.interpolation)

triangle (pyfvcom2.mesh_reader.MeshData attribute) triangles (pyfvcom2.grid.Grid property) triangulation_elements_cartesian (pyfvcom2.interpolation.FVCOMInterpolator property) triangulation_elements_geographic (pyfvcom2.interpolation.FVCOMInterpolator property) triangulation_nodes_cartesian (pyfvcom2.interpolation.FVCOMInterpolator property) triangulation_nodes_geographic (pyfvcom2.interpolation.FVCOMInterpolator property) types_bdy (pyfvcom2.grid.Grid property) (pyfvcom2.mesh_reader.MeshData attribute)

U

unmasked_lats (pyfvcom2.cmems_reader.CMEMSReader property) unmasked_lons (pyfvcom2.cmems_reader.CMEMSReader property) update() (pyfvcom2.namelist.NamelistManager method)

update_nesting_interval() (pyfvcom2.namelist.NamelistManager method) update_nudging() (pyfvcom2.namelist.NamelistManager method) update_ramp() (pyfvcom2.namelist.NamelistManager method) utm_from_lonlat() (in module pyfvcom2.coordinates)

V

valid_nesting_timescale() (pyfvcom2.namelist.NamelistManager method) value() (pyfvcom2.namelist.NamelistManager method)

var_is_node_based() (pyfvcom2.fvcom_reader.FVCOMReader method) vertical_coordinate_system (pyfvcom2.interpolation.InterpolationCoordinates property) (pyfvcom2.interpolation_coordinates.InterpolationCoordinates property)

W

WeightsCalculator (class in pyfvcom2.weights_calculator) write() (pyfvcom2.namelist.NamelistManager method) write_bed_roughness() (pyfvcom2.grid.Grid method) write_coriolis() (pyfvcom2.grid.Grid method) write_fvcom_time() (pyfvcom2.fvcom_writer.FVCOMWriter method)

write_grid() (pyfvcom2.grid.Grid method) write_obc() (pyfvcom2.grid.Grid method) write_restart() (in module pyfvcom2.restart) write_sigma() (pyfvcom2.grid.Grid method) write_sigma_file() (in module pyfvcom2.sigma) write_sponge() (pyfvcom2.grid.Grid method)

X

x1 (pyfvcom2.interpolation.InterpolationCoordinates property) (pyfvcom2.interpolation_coordinates.InterpolationCoordinates property) (pyfvcom2.mesh_reader.MeshData attribute) x2 (pyfvcom2.interpolation.InterpolationCoordinates property) (pyfvcom2.interpolation_coordinates.InterpolationCoordinates property) (pyfvcom2.mesh_reader.MeshData attribute)

x3 (pyfvcom2.interpolation.InterpolationCoordinates property) (pyfvcom2.interpolation_coordinates.InterpolationCoordinates property) (pyfvcom2.mesh_reader.MeshData attribute) x_elements (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property) x_nodes (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property)

Y

y_elements (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property)

y_nodes (pyfvcom2.fvcom_reader.FVCOMReader property) (pyfvcom2.grid.Grid property)

Z

z_layers_static (pyfvcom2.grid.Grid property) z_levels_static (pyfvcom2.grid.Grid property) z_to_sigma_coords() (in module pyfvcom2.coordinates) zbar() (in module pyfvcom2.ocean)

zc_layers_static (pyfvcom2.grid.Grid property) zc_levels_static (pyfvcom2.grid.Grid property) zkl (pyfvcom2.sigma.SigmaConfig attribute) zku (pyfvcom2.sigma.SigmaConfig attribute)