BELLHOP Python API Documentation

This is the Python API documentation for BELLHOP, an underwater acoustic propagation modeling toolbox.

Contents:

• Code reference
  • File structure
• Environment class
  • Environment class
    • Environment
• Internal constants
  • Internal constants
    • _File_Ext
    • _Strings
    • _Maps
    • Defaults
• Reading from Bellhop text files
  • read_env()
  • EnvironmentReader
    • EnvironmentReader.read()
  • read_ssp()
  • read_bty()
  • read_ati()
  • read_ati_bty()
  • read_sbp()
  • read_brc()
  • read_trc()
  • read_refl_coeff()
  • read_arrivals()
  • read_shd()
  • read_rays()
• Plotting Reference
  • Plotting functions (bokeh)
    • Any
    • Environment
    • figure
    • plot_env()
    • plot_ssp()
    • plot_arrivals()
    • plot_rays()
    • plot_transmission_loss()
  • Plotting utilities (bokeh)
    • theme()
    • figsize()
    • interactive()
    • enable_javascript()
    • use_static_images()
    • hold()
    • figure
    • many_figures
    • next_row()
    • next_column()
    • gcf()
    • plot()
    • scatter()
    • image()
    • vlines()
    • hlines()
    • text()
    • box()
    • color()
    • set_colors()
    • specgram()
    • psd()
    • iqplot()
    • freqz()
  • Plotting functions (matplotlib)
    • Any
    • pyplot_env()
    • pyplot_ssp()
    • pyplot_arrivals()
    • pyplot_rays()
    • pyplot_transmission_loss()
• All package functions
  • Any
  • Defaults
    • Defaults.beam_angle_fullspace
    • Defaults.beam_angle_halfspace
    • Defaults.env_comment_pad
    • Defaults.exe
    • Defaults.interference_mode
    • Defaults.model_name
  • read_env()
  • read_ssp()
  • read_ati()
  • read_bty()
  • read_sbp()
  • read_trc()
  • read_brc()
  • read_shd()
  • read_rays()
  • read_arrivals()
  • Environment
    • Environment._abc_impl
    • Environment._altimetry
    • Environment._bathymetry
    • Environment._bottom_attenuation_shear
    • Environment._bottom_soundspeed_shear
    • Environment._check_env_beam()
    • Environment._check_env_depth()
    • Environment._check_env_header()
    • Environment._check_env_sbp()
    • Environment._check_env_ssp()
    • Environment._check_env_surface()
    • Environment._depth_sigma
    • Environment._finalise()
    • Environment._mesh_npts
    • Environment._num_media
    • Environment._sbp_file
    • Environment._single_beam
    • Environment._surface_attenuation_shear
    • Environment._surface_soundspeed_shear
    • Environment.attenuation_units
    • Environment.beam_angle_max
    • Environment.beam_angle_min
    • Environment.beam_num
    • Environment.beam_type
    • Environment.bottom_attenuation
    • Environment.bottom_beta
    • Environment.bottom_boundary_condition
    • Environment.bottom_density
    • Environment.bottom_interp
    • Environment.bottom_reflection_coefficient
    • Environment.bottom_roughness
    • Environment.bottom_soundspeed
    • Environment.bottom_transition_freq
    • Environment.box_depth
    • Environment.box_range
    • Environment.check()
    • Environment.copy()
    • Environment.depth
    • Environment.depth_interp
    • Environment.depth_max
    • Environment.fg_depth
    • Environment.fg_pH
    • Environment.fg_salinity
    • Environment.fg_temperature
    • Environment.frequency
    • Environment.grid_type
    • Environment.interference_mode
    • Environment.name
    • Environment.receiver_depth
    • Environment.receiver_ndepth
    • Environment.receiver_nrange
    • Environment.receiver_range
    • Environment.single_beam_index
    • Environment.soundspeed
    • Environment.soundspeed_interp
    • Environment.source_depth
    • Environment.source_directionality
    • Environment.source_ndepth
    • Environment.source_type
    • Environment.step_size
    • Environment.surface
    • Environment.surface_attenuation
    • Environment.surface_boundary_condition
    • Environment.surface_density
    • Environment.surface_depth
    • Environment.surface_interp
    • Environment.surface_reflection_coefficient
    • Environment.surface_soundspeed
    • Environment.task
    • Environment.to_dict()
    • Environment.type
    • Environment.volume_attenuation
  • Bellhop
    • Bellhop._array2str()
    • Bellhop._check_error()
    • Bellhop._create_bty_ati_file()
    • Bellhop._create_env_file()
    • Bellhop._create_refl_coeff_file()
    • Bellhop._create_sbp_file()
    • Bellhop._create_ssp_quad_file()
    • Bellhop._float()
    • Bellhop._prepare_env_file()
    • Bellhop._print()
    • Bellhop._print_array()
    • Bellhop._print_env_line()
    • Bellhop._quoted_opt()
    • Bellhop._rm_files()
    • Bellhop._run_exe()
    • Bellhop._unlink()
    • Bellhop._write_env_beam_footer()
    • Bellhop._write_env_bottom()
    • Bellhop._write_env_header()
    • Bellhop._write_env_sound_speed()
    • Bellhop._write_env_source_receiver()
    • Bellhop._write_env_surface_depth()
    • Bellhop._write_env_task()
    • Bellhop.run()
    • Bellhop.supports()
    • Bellhop.taskmap
  • new_model()
  • models()
  • create_env2d()
  • create_env()
  • check_env()
  • check_env2d()
  • compute()
  • compute_arrivals()
  • compute_eigenrays()
  • compute_rays()
  • compute_transmission_loss()
  • arrivals_to_impulse_response()

Indices and tables

• Index

• Module Index

• Search Page