.. _examples:

========
Examples
========

Examples of the high-level API functionality are provided here. These examples range from simple particle routing with a flow field, to measuring exposure time distributions for particle transport in a specified region. If your use case extends beyond the scenarios explored in these examples, we recommend using the `routines.py` script to help you design your own functions based on the lower-level methods in `particle_track.py`.

.. Note::
    To run :ref:`example12`, you must be in the "examples" directory. Pathing
    to the data for that example is relative to the working directory and
    assumes you are in the "examples" directory.

    Similarly, for :ref:`example03`, :ref:`example07`, and :ref:`example08`
    these must be run from the same location (same directory) from which you
    ran the prerequisite example (e.g. :ref:`example02` must be run before
    :ref:`example03`)

.. toctree::
   :maxdepth: 1

   example01
   example02
   example03
   example04
   example05
   example06
   example07
   example08
   example09
   example10
   example11
   example12
   example13
   example14


External Examples
-----------------

Below are links to examples of `dorado` being used in other projects.
If you have used `dorado` as part of your project and have an example or graphic hosted online, please let us know and we will add a link to it here.

`Tides on a simple 2D field <https://espin-2020.github.io/CoastalTeam/examples/HomogeneousField2D/HomogeneousField2D.html>`_ - an example of coupling `dorado` with `Landlab <https://landlab.github.io>`_.

`Tides on a randomly vegetated field <https://espin-2020.github.io/CoastalTeam/examples/RandomField2D/RandomField2D.html>`_ - another example of coupling `dorado` with `Landlab <https://landlab.github.io>`_.