pymarine package

Subpackages

• pymarine.utils package
  • Submodules
  • pymarine.utils.coordinate_transformations module
    • cartesian_to_cylindrical()
    • cartesian_to_polar()
    • cartesian_to_spherical()
    • colatitude_to_latitude()
    • cylindrical_to_cartesian()
    • latitude_to_colatitude()
    • polar_to_cartesian()
    • spherical_to_cartesian()
  • pymarine.utils.date_time module
    • matlabnum2date()
    • valid_date()
  • pymarine.utils.file_and_directory module
    • get_path_depth()
    • make_directory()
    • scan_base_directory()
  • pymarine.utils.geographic module
    • LocationCheck
      • LocationCheck.make_report()
      • LocationCheck.out_of_range()
    • get_speed_from_distance_and_time()
    • import_way_points()
    • travel_distance_and_heading_from_coordinates()
  • pymarine.utils.misc module
    • Chdir
    • ConditionalDecorator
    • PackageInfo
      • PackageInfo.get_bundle_version()
      • PackageInfo.get_source_version()
    • Timer
    • clear_argument_list()
    • clear_path()
    • compare_objects()
    • delete_module()
    • get_clean_version()
    • get_python_version_number()
    • get_regex_pattern()
    • get_time_stamp_from_string()
    • get_value_magnitude()
    • is_exe()
    • move_script_path_to_back_of_search_path()
    • print_banner()
    • query_yes_no()
    • read_settings_file()
    • read_value_from_dict_if_valid()
    • set_default_dimension()
    • set_value_if_valid()
  • pymarine.utils.numerical module
    • ecdf2percentile()
    • extrap1d()
    • find_idx_nearest_val()
    • get_column_with_max_cumulative_value()
    • get_nearest_index()
    • get_parameter_list_key()
    • get_range_from_string()
    • loadmat()
    • make_2d_array_cyclic()
    • nans()
    • print_mat_nested()
  • pymarine.utils.plotting module
    • analyse_annotations()
    • clean_up_artists()
    • clean_up_plot()
    • clear_all_legends()
    • flip()
    • get_valid_legend_handles_labels()
    • set_limits()
    • sub_plot_axis_to_2d()
  • Module contents
• pymarine.waves namespace
  • Submodules
  • pymarine.waves.wave_fields module
    • Wave1D: Theoretical background on one-D waves
      • Wave equation with DFT
      • Wave equation with FFT
    • Wave2D: Theoretical background on two-D waves
      • 2D DFT implementation
      • 2D FFT implementation
    • Start of the wave_fields implementation
    • PlotProperties
    • Wave1D
      • Wave1D.kx_nodes
      • Wave1D.xpoints
      • Wave1D.amplitude
      • Wave1D.phase
      • Wave1D.omega_dispersion
      • Wave1D.spectrumK
      • Wave1D.spectrumW
      • Wave1D.complex_amplitudes
      • Wave1D.delta_x
      • Wave1D.kx_nyquist
      • Wave1D.animate_wave()
      • Wave1D.calculate_omega_dispersion()
      • Wave1D.calculate_spectra_modulus()
      • Wave1D.calculate_wave_surface()
      • Wave1D.dft_complex_amplitudes()
      • Wave1D.fft_amplitude()
      • Wave1D.limit_markers()
      • Wave1D.make_report()
      • Wave1D.next_time()
      • Wave1D.plot_spectrum()
      • Wave1D.plot_wave()
      • Wave1D.propagate_wave()
      • Wave1D.reset_time()
      • Wave1D.set_wave_construction()
      • Wave1D.update_x_k_t_sample_space()
    • Wave2D
      • Wave2D.animate_wave()
      • Wave2D.calculate_omega_dispersion()
      • Wave2D.calculate_spectral_components()
      • Wave2D.calculate_spreading_function()
      • Wave2D.calculate_wave_surface()
      • Wave2D.dft_complex_amplitudes()
      • Wave2D.export_complex_amplitudes()
      • Wave2D.fft_amplitude()
      • Wave2D.make_report()
      • Wave2D.plot_spectrum()
      • Wave2D.plot_wave()
      • Wave2D.propagate_wave()
      • Wave2D.update_k_polar_mesh()
      • Wave2D.update_x_k_theta_sample_space()
  • pymarine.waves.wave_spectra module
    • ag_taylor_expand()
    • alpha_jonswap()
    • d_omega_e_prime()
    • initialize_phase()
    • mask_out_of_range()
    • omega_critical()
    • omega_deep_water()
    • omega_e_vs_omega()
    • omega_peak_jonswap()
    • omega_vs_omega_e()
    • rayleigh_cdf()
    • rayleigh_pdf()
    • rotate_fft_2d()
    • set_heading()
    • specspecs()
    • spectrum2d_complex_amplitudes()
    • spectrum2d_to_spectrum2d_encountered()
    • spectrum_complex_amplitudes_on_k_mesh()
    • spectrum_gauss()
    • spectrum_jonswap()
    • spectrum_jonswap_k_domain_2()
    • spectrum_to_complex_amplitudes()
    • spectrum_to_spectrum_encountered()
    • spectrum_wave_k_domain()
    • spreading_function()
    • spreading_function2()
    • thetaspreadspecs()

Module contents