pylag.processing package

Submodules

• pylag.processing.animation module
  • Animation
    • Animation.make_animation()
    • Animation.make_image()
  • ParticleTrajectoryAnimation
    • ParticleTrajectoryAnimation.make_image()
• pylag.processing.coordinate module
  • british_national_grid_to_lonlat()
  • check_valid_zone()
  • get_epsg_code()
  • get_zone_letter()
  • get_zone_number()
  • lonlat_decimal_from_degminsec()
  • lonlat_decimal_from_degminsec_wco()
  • lonlat_from_utm()
  • to_ndarray()
  • utm_from_lonlat()
• pylag.processing.ensemble module
  • get_probability_density_1D()
  • get_probability_density_2D()
• pylag.processing.fvcom module
  • get_rmse()
• pylag.processing.gotm module
  • get_rmse()
• pylag.processing.input module
  • create_initial_positions_file_multi_group()
  • create_initial_positions_file_single_group()
• pylag.processing.ncview module
  • Viewer
    • Viewer.close()
    • Viewer.date
    • Viewer.list_vars()
    • Viewer.time
    • Viewer.var_info()
• pylag.processing.plot module
  • ArakawaAPlotter
    • ArakawaAPlotter.draw_grid()
    • ArakawaAPlotter.plot_field()
    • ArakawaAPlotter.plot_quiver()
    • ArakawaAPlotter.preprocess_array()
  • ArakawaCPlotter
    • ArakawaCPlotter.draw_grid()
    • ArakawaCPlotter.plot_field()
    • ArakawaCPlotter.plot_lines()
    • ArakawaCPlotter.remove_line_plots()
    • ArakawaCPlotter.scatter()
    • ArakawaCPlotter.set_title()
  • FVCOMPlotter
    • FVCOMPlotter.draw_grid()
    • FVCOMPlotter.plot_field()
    • FVCOMPlotter.plot_quiver()
  • GOTMPlotter
    • GOTMPlotter.add_colour_bar()
    • GOTMPlotter.hovmoller()
    • GOTMPlotter.hovmoller_particles()
    • GOTMPlotter.plot_pathlines()
    • GOTMPlotter.plot_scatter()
    • GOTMPlotter.profile()
    • GOTMPlotter.set_title()
    • GOTMPlotter.time_series()
  • PyLagPlotter
    • PyLagPlotter.plot_lines()
    • PyLagPlotter.remove_line_plots()
    • PyLagPlotter.scatter()
    • PyLagPlotter.set_title()
  • cm2inch()
  • colourmap()
  • create_cbar_ax()
  • create_figure()
• pylag.processing.release_zone module
  • ReleaseZone
    • ReleaseZone.add_particle()
    • ReleaseZone.create_particle_set()
    • ReleaseZone.get_area()
    • ReleaseZone.get_centre()
    • ReleaseZone.get_coords()
    • ReleaseZone.get_depths()
    • ReleaseZone.get_eastings()
    • ReleaseZone.get_group_id()
    • ReleaseZone.get_northings()
    • ReleaseZone.get_number_of_particles()
    • ReleaseZone.get_particle_set()
    • ReleaseZone.get_radius()
    • ReleaseZone.get_zone_polygon()
    • ReleaseZone.set_group_id()
  • create_release_zone()
  • create_release_zones_along_cord()
  • create_release_zones_around_shape()
  • create_release_zones_around_shape_section()
• pylag.processing.utils module
  • get_file_list()
  • get_grid_bands()
  • get_time_index()
  • round_time()

Module contents

pylag.processing

The pylag.processing subpackage contains modules to assist with setting up and analysing PyLag simulations. By default, the dependencies required by the pylag.processing subpackage are not installed with the base code. This is to keep the overall size of the package small and to make it easier to handle dependency clashes. To enable the pylag.processing subpackage, please install the extra dependencies listed in the installation guide: https://pylag.readthedocs.io/en/latest/.