pyfvcom2 package

Subpackages

• pyfvcom2.plotting package
  • Submodules
    • pyfvcom2.plotting.plot module
      • CMEMSPlotter
      • FVCOMPlotter
      • PyFVCOM2Plotter
      • cm2inch()
      • colourmap()
      • create_cbar_ax()
      • create_figure()
  • Module contents
    • CMEMSPlotter
      • CMEMSPlotter.plot_field()
      • CMEMSPlotter.scatter()
    • FVCOMPlotter
      • FVCOMPlotter.draw_grid()
      • FVCOMPlotter.plot_field()
      • FVCOMPlotter.plot_quiver()
      • FVCOMPlotter.scatter()
    • PyFVCOM2Plotter
      • PyFVCOM2Plotter.plot_field()
      • PyFVCOM2Plotter.plot_lines()
      • PyFVCOM2Plotter.remove_line_plots()
      • PyFVCOM2Plotter.scatter()
      • PyFVCOM2Plotter.set_title()
    • cm2inch()
    • colourmap()
    • create_cbar_ax()
    • create_figure()

Submodules

• pyfvcom2.bathy_smoother module
  • BathymetrySmoother
    • BathymetrySmoother.r_factor()
    • BathymetrySmoother.smooth()
  • GlobalBathymetrySmoother
    • GlobalBathymetrySmoother.smooth()
• pyfvcom2.cmems_reader module
  • CMEMSReader
    • CMEMSReader.close()
    • CMEMSReader.contains_date()
    • CMEMSReader.dates
    • CMEMSReader.depth_levels
    • CMEMSReader.get_bottom_indices()
    • CMEMSReader.get_closest_date_index()
    • CMEMSReader.get_filled_2D_var()
    • CMEMSReader.get_filled_3D_var()
    • CMEMSReader.get_filled_3D_var_by_index()
    • CMEMSReader.get_mask()
    • CMEMSReader.get_unmasked_var_by_index()
    • CMEMSReader.get_unmasked_variable()
    • CMEMSReader.get_var()
    • CMEMSReader.get_var_by_index()
    • CMEMSReader.get_var_ndims()
    • CMEMSReader.lats
    • CMEMSReader.lats_2D
    • CMEMSReader.lons
    • CMEMSReader.lons_2D
    • CMEMSReader.n_depths
    • CMEMSReader.n_files
    • CMEMSReader.time_span
    • CMEMSReader.unmasked_lats
    • CMEMSReader.unmasked_lons
• pyfvcom2.coordinates module
  • cart2pol()
  • get_epsg_code()
  • lonlat_from_utm()
  • pol2cart()
  • sigma_to_z_coords()
  • utm_from_lonlat()
  • z_to_sigma_coords()
• pyfvcom2.date_utils module
  • create_datetime_array()
  • round_time()
• pyfvcom2.exceptions module
  • PyFVCOM2AttributeError
  • PyFVCOM2Exception
  • PyFVCOM2FileNotFoundError
  • PyFVCOM2RuntimeError
  • PyFVCOM2TypeError
  • PyFVCOM2ValueError
• pyfvcom2.file_utils module
  • find_file()
  • find_files()
• pyfvcom2.fvcom_reader module
  • FVCOMReader
    • FVCOMReader.DAYS_PER_MILLISECOND
    • FVCOMReader.bathy_elements
    • FVCOMReader.bathy_nodes
    • FVCOMReader.dates
    • FVCOMReader.get_interpolation_coordinates()
    • FVCOMReader.get_n_depth_levels()
    • FVCOMReader.get_sigma_levels()
    • FVCOMReader.get_time_dep_z_levels()
    • FVCOMReader.get_var()
    • FVCOMReader.get_var_dimensions()
    • FVCOMReader.get_vertical_position()
    • FVCOMReader.grid
    • FVCOMReader.lat_elements
    • FVCOMReader.lat_nodes
    • FVCOMReader.lon_elements
    • FVCOMReader.lon_nodes
    • FVCOMReader.n_elements
    • FVCOMReader.n_nodes
    • FVCOMReader.n_sigma_layers
    • FVCOMReader.n_sigma_levels
    • FVCOMReader.sigma_layers_elements
    • FVCOMReader.sigma_layers_nodes
    • FVCOMReader.sigma_levels_elements
    • FVCOMReader.sigma_levels_nodes
    • FVCOMReader.var_is_node_based()
    • FVCOMReader.x_elements
    • FVCOMReader.x_nodes
    • FVCOMReader.y_elements
    • FVCOMReader.y_nodes
• pyfvcom2.fvcom_writer module
  • FVCOMWriter
    • FVCOMWriter.add_variable()
    • FVCOMWriter.write_fvcom_time()
• pyfvcom2.grid module
  • Grid
    • Grid.bathy_elements
    • Grid.bathy_nodes
    • Grid.get_interpolation_coordinates()
    • Grid.lat_elements
    • Grid.lat_nodes
    • Grid.lon_elements
    • Grid.lon_nodes
    • Grid.n_elements
    • Grid.n_nodes
    • Grid.n_open_boundaries
    • Grid.n_sigma_layers
    • Grid.n_sigma_levels
    • Grid.nodes_bdy
    • Grid.set_bed_roughness()
    • Grid.sigma_config
    • Grid.sigma_layers
    • Grid.sigma_layers_elements
    • Grid.sigma_layers_nodes
    • Grid.sigma_levels
    • Grid.sigma_levels_elements
    • Grid.sigma_levels_nodes
    • Grid.sigmac_layers
    • Grid.sigmac_levels
    • Grid.triangles
    • Grid.types_bdy
    • Grid.write_bed_roughness()
    • Grid.write_coriolis()
    • Grid.write_grid()
    • Grid.write_obc()
    • Grid.write_sigma()
    • Grid.write_sponge()
    • Grid.x_elements
    • Grid.x_nodes
    • Grid.y_elements
    • Grid.y_nodes
    • Grid.z_layers_static
    • Grid.z_levels_static
    • Grid.zc_layers_static
    • Grid.zc_levels_static
  • OpenBoundary
    • OpenBoundary.bdy_id
    • OpenBoundary.bdy_type
    • OpenBoundary.nnodes
    • OpenBoundary.node_indices
    • OpenBoundary.set_sponge()
    • OpenBoundary.set_type()
    • OpenBoundary.sigma_layers
    • OpenBoundary.sigma_levels
    • OpenBoundary.sponge_coefficient
    • OpenBoundary.sponge_radius
  • connectivity()
  • find_connected_elements()
  • nodes2elems()
• pyfvcom2.grid_builder module
  • build_fvcom_grid()
• pyfvcom2.interpolation module
  • CMEMSInterpolator
    • CMEMSInterpolator.interpolate()
  • FVCOMInterpolator
    • FVCOMInterpolator.generate_land_sea_mask()
    • FVCOMInterpolator.interpolate()
    • FVCOMInterpolator.triangulation_elements_cartesian
    • FVCOMInterpolator.triangulation_elements_geographic
    • FVCOMInterpolator.triangulation_nodes_cartesian
    • FVCOMInterpolator.triangulation_nodes_geographic
  • Interpolator
    • Interpolator.interpolate()
  • NEMOInterpolator
    • NEMOInterpolator.interpolate()
  • TPXOInterpolator
    • TPXOInterpolator.interpolate()
• pyfvcom2.interpolation_coordinates module
  • InterpolationCoordinates
    • InterpolationCoordinates.dates
    • InterpolationCoordinates.horizontal_coordinate_system
    • InterpolationCoordinates.vertical_coordinate_system
    • InterpolationCoordinates.x1
    • InterpolationCoordinates.x2
    • InterpolationCoordinates.x3
• pyfvcom2.lanczos module
  • LanczosFilter
    • LanczosFilter.filter()
  • lanczos()
• pyfvcom2.mesh_reader module
  • MeshData
    • MeshData.nodes
    • MeshData.nodes_bdy
    • MeshData.triangle
    • MeshData.types_bdy
    • MeshData.x1
    • MeshData.x2
    • MeshData.x3
  • parse_obc_sections()
  • read_fvcom_mesh()
  • read_fvcom_obc()
  • read_gmsh_mesh()
  • read_mesh_file()
  • read_mike_mesh()
  • read_smesh_mesh()
  • read_sms_mesh()
• pyfvcom2.namelist module
  • NamelistManager
    • NamelistManager.update()
    • NamelistManager.update_nesting_interval()
    • NamelistManager.update_nudging()
    • NamelistManager.update_ramp()
    • NamelistManager.valid_nesting_timescale()
    • NamelistManager.value()
    • NamelistManager.write()
• pyfvcom2.nemo_reader module
  • NEMOReader
    • NEMOReader.close()
    • NEMOReader.contains_date()
    • NEMOReader.dates()
    • NEMOReader.depth_levels()
    • NEMOReader.depth_levels_for_variable()
    • NEMOReader.depth_var_name()
    • NEMOReader.get_bracketing_times()
    • NEMOReader.get_closest_date_index()
    • NEMOReader.get_mask()
    • NEMOReader.get_var()
    • NEMOReader.get_var_ndims()
    • NEMOReader.get_vertical_coordinates()
    • NEMOReader.grid_angle()
    • NEMOReader.grid_for_variable()
    • NEMOReader.grid_names
    • NEMOReader.lat_var_name()
    • NEMOReader.lats()
    • NEMOReader.lats_for_variable()
    • NEMOReader.lon_var_name()
    • NEMOReader.lons()
    • NEMOReader.lons_for_variable()
    • NEMOReader.time_span()
    • NEMOReader.time_var_name()
• pyfvcom2.nest module
  • GridBand
    • GridBand.element_weights
    • GridBand.elements
    • GridBand.node_weights
    • GridBand.nodes
  • Nest
    • Nest.add_grid_band()
    • Nest.get_grid_bands()
  • NestManager
    • NestManager.add_forcing_data()
    • NestManager.add_nest()
    • NestManager.add_tidal_data()
    • NestManager.apply_ramp()
    • NestManager.clear_nests()
    • NestManager.create_forcing_file()
    • NestManager.get_all_element_weights()
    • NestManager.get_all_nest_elements()
    • NestManager.get_all_nest_nodes()
    • NestManager.get_all_node_weights()
    • NestManager.get_forcing_data()
    • NestManager.get_interpolation_coordinates()
    • NestManager.get_nests()
    • NestManager.get_tidal_data()
    • NestManager.make_nests()
    • NestManager.set_dates()
• pyfvcom2.obc module
  • OBCManager
    • OBCManager.add_tidal_data()
    • OBCManager.create_forcing_file()
    • OBCManager.set_dates()
• pyfvcom2.ocean module
  • cond2salt()
  • cp_sw()
  • dT_adiab_sw()
  • dens_jackett()
  • depth2pressure()
  • dissipation()
  • mixedlayerdepth()
  • pea()
  • pressure2depth()
  • rhum()
  • simpsonhunter()
  • stokes()
  • sw_dens()
  • sw_dens0()
  • sw_sal78()
  • sw_sal80()
  • sw_salinity()
  • sw_seck()
  • sw_smow()
  • sw_svan()
  • theta_sw()
  • zbar()
• pyfvcom2.restart module
  • interpolate_restart_data()
  • write_restart()
• pyfvcom2.sigma module
  • SigmaConfig
    • SigmaConfig.dl
    • SigmaConfig.du
    • SigmaConfig.kl
    • SigmaConfig.ku
    • SigmaConfig.min_constant_depth
    • SigmaConfig.nlev
    • SigmaConfig.sigpow
    • SigmaConfig.sigtype
    • SigmaConfig.zkl
    • SigmaConfig.zku
  • SigmaData
    • SigmaData.sigma_config
    • SigmaData.sigma_levels
  • hybrid_sigma_coordinate()
  • process_sigma_config()
  • read_sigma_file()
  • sigma_generalized()
  • sigma_geometric()
  • sigma_tanh()
  • write_sigma_file()
• pyfvcom2.tide module
  • HarmonicAnalysisWriter
    • HarmonicAnalysisWriter.add_grid()
    • HarmonicAnalysisWriter.add_harmonics()
    • HarmonicAnalysisWriter.add_predicted()
    • HarmonicAnalysisWriter.add_raw()
  • HarmonicsAnalyser
    • HarmonicsAnalyser.run()
  • TideManager
    • TideManager.add_interpolator()
    • TideManager.constituents
    • TideManager.predict()
  • analyse_harmonics()
  • extend_datetime_array()
  • predict_tide()
  • reconstruct_wrapper()
• pyfvcom2.tide_reader module
  • FVCOMHarmonicsNames
    • FVCOMHarmonicsNames.amplitude_var_name
    • FVCOMHarmonicsNames.apply_transport_unit_conversion
    • FVCOMHarmonicsNames.bathy_var_name
    • FVCOMHarmonicsNames.constituents_var_name
    • FVCOMHarmonicsNames.lat_var_name
    • FVCOMHarmonicsNames.lon_var_name
    • FVCOMHarmonicsNames.phase_var_name
  • FVCOMHarmonicsReader
    • FVCOMHarmonicsReader.read_harmonics()
  • HarmonicsData
    • HarmonicsData.amplitudes
    • HarmonicsData.constituents
    • HarmonicsData.latitude
    • HarmonicsData.longitude
    • HarmonicsData.phases
  • HarmonicsReader
    • HarmonicsReader.read_harmonics()
  • TPXOComplexHarmonicsNames
    • TPXOComplexHarmonicsNames.apply_transport_unit_conversion
    • TPXOComplexHarmonicsNames.bathy_var_name
    • TPXOComplexHarmonicsNames.constituents_var_name
    • TPXOComplexHarmonicsNames.lat_var_name
    • TPXOComplexHarmonicsNames.lon_var_name
    • TPXOComplexHarmonicsNames.part1_var_name
    • TPXOComplexHarmonicsNames.part2_var_name
  • TPXOComplexHarmonicsReader
    • TPXOComplexHarmonicsReader.read_harmonics()
  • TPXOHarmonicsNames
    • TPXOHarmonicsNames.amplitude_var_name
    • TPXOHarmonicsNames.apply_transport_unit_conversion
    • TPXOHarmonicsNames.bathy_var_name
    • TPXOHarmonicsNames.constituents_var_name
    • TPXOHarmonicsNames.lat_var_name
    • TPXOHarmonicsNames.lon_var_name
    • TPXOHarmonicsNames.phase_var_name
  • TPXOHarmonicsReader
    • TPXOHarmonicsReader.read_harmonics()
• pyfvcom2.weights_calculator module
  • ExponentialWeightsCalculator
    • ExponentialWeightsCalculator.calculate_weights()
  • LinearWeightsCalculator
    • LinearWeightsCalculator.calculate_weights()
  • WeightsCalculator
    • WeightsCalculator.calculate_weights()
  • get_weights_calculator()