Welcome to the documentation of parcels. This page provides detailed documentation for each method, class and function. The documentation corresponds to the latest conda release, for newer documentation see the docstrings in the code.
See http://www.oceanparcels.org for general information on the Parcels project, including how to install and use.
.. automodule:: parcels.particleset.particlesetsoa :members: :show-inheritance:
.. automodule:: parcels.fieldset :members: :show-inheritance:
.. automodule:: parcels.field :members: :show-inheritance:
.. automodule:: parcels.gridset :members: :show-inheritance:
.. automodule:: parcels.grid :members: :show-inheritance:
.. automodule:: parcels.particle :members: :show-inheritance:
.. automodule:: parcels.application_kernels.advection :members: :show-inheritance:
.. automodule:: parcels.application_kernels.advectiondiffusion :members: :show-inheritance:
.. automodule:: parcels.application_kernels.EOSseawaterproperties :members: :show-inheritance:
.. automodule:: parcels.application_kernels.TEOSseawaterdensity :members: :show-inheritance:
.. automodule:: parcels.compilation :members: :show-inheritance: yes
.. automodule:: parcels.interaction :members: :show-inheritance: yes
.. automodule:: parcels.interaction.neighborsearch :members: :show-inheritance: yes
.. automodule:: parcels.kernel.basekernel :members: :undoc-members:
.. automodule:: parcels.kernel.kernelaos :members: :undoc-members:
.. automodule:: parcels.kernel.kernelsoa :members: :undoc-members:
.. automodule:: parcels.particlefile.baseparticlefile :members: :show-inheritance: yes
.. automodule:: parcels.particlefile.particlefileaos :members: :show-inheritance: yes
.. automodule:: parcels.particlefile.particlefilesoa :members: :show-inheritance: yes
.. automodule:: parcels.rng :members: :undoc-members:
.. automodule:: parcels.particleset.baseparticleset :members: :show-inheritance:
.. automodule:: parcels.particleset.particlesetaos :members: :show-inheritance:
.. automodule:: parcels.tools.statuscodes :members: :show-inheritance:
.. automodule:: parcels.tools.converters :members: :show-inheritance:
.. automodule:: parcels.tools.loggers :members: :undoc-members:
.. automodule:: parcels.plotting :members: :undoc-members:
.. automodule:: scripts.plottrajectoriesfile :members: :undoc-members:
.. automodule:: scripts.get_examples :members: :undoc-members: