API Reference
==============

.. contents::
    :local:
    :backlinks: none

RiverGrid class
----------------

.. autoclass:: fluvial_particle.RiverGrid.RiverGrid
    :members:

    .. automethod:: __init__

Particles class
----------------

.. autoclass:: fluvial_particle.Particles.Particles
    :members:

    .. automethod:: __init__

FallingParticles class
-----------------------

.. autoclass:: fluvial_particle.FallingParticles.FallingParticles
    :members:

    .. automethod:: __init__

LarvalParticles class
-----------------------

.. autoclass:: fluvial_particle.LarvalParticles.LarvalParticles
    :members:

    .. automethod:: __init__

LarvalBotParticles class
-------------------------

.. autoclass:: fluvial_particle.LarvalParticles.LarvalBotParticles
    :members:

    .. automethod:: __init__

LarvalTopParticles class
-------------------------

.. autoclass:: fluvial_particle.LarvalParticles.LarvalTopParticles
    :members:

    .. automethod:: __init__

Helpers
----------------

.. automodule:: fluvial_particle.Helpers
    :members:

Settings
------------

.. automodule:: fluvial_particle.Settings
    :members:

Core API
---------

.. automodule:: fluvial_particle
   :members:

Simulation
----------

.. automodule:: fluvial_particle.simulation
   :members:

Command Line Interface
----------------------

.. automodule:: fluvial_particle.cli
   :members: