API Reference¶

Below are links to the API reference for each component of the dorado software.

  • dorado.particle_track
    • Particles
    • coord2ind()
    • exposure_time()
    • gen_input_check()
    • ind2coord()
    • modelParams
    • nourishment_area()
    • nourishment_time()
    • unstruct2grid()
  • dorado.lagrangian_walker
    • big_sliding_window()
    • calc_travel_times()
    • calculate_new_ind()
    • check_for_boundary()
    • clear_borders()
    • get_weight()
    • make_weight()
    • particle_stepper()
    • random_pick()
    • random_pick_seed()
    • steep_descent()
    • step_update()
    • tile_domain_array()
    • tile_local_array()
  • dorado.routines
    • animate_plots()
    • draw_travel_path()
    • get_state()
    • get_time_state()
    • plot_exposure_time()
    • plot_state()
    • show_nourishment_area()
    • show_nourishment_time()
    • snake_plots()
    • steady_plots()
    • time_plots()
    • unsteady_plots()
  • dorado.parallel_routing
    • combine_result()
    • parallel_obj
    • parallel_routing()
    • run_iter()

Search¶

  • Search Page

dorado

Navigation

  • Installation Instructions
  • Quickstart
  • Background
  • Paper
  • User Guide
  • Examples
  • dorado In Publications
  • License
  • Contributing
  • API Reference
  • Acknowledgments

Related Topics

  • Documentation overview
    • Previous: Contributing
    • Next: dorado.particle_track
©2020, J. Hariharan, K. Wright, P. Passalacqua. | Powered by Sphinx 8.2.3 & Alabaster 1.0.0 | Page source