opendrift
=========

.. py:module:: opendrift

.. autoapi-nested-parse::

   Opendrift module

   .. currentmodule:: opendrift

   .. doctest::

       >>> import opendrift



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/opendrift/config/index
   /autoapi/opendrift/elements/index
   /autoapi/opendrift/errors/index
   /autoapi/opendrift/export/index
   /autoapi/opendrift/legacy/index
   /autoapi/opendrift/models/index
   /autoapi/opendrift/readers/index
   /autoapi/opendrift/timer/index
   /autoapi/opendrift/version/index


Attributes
----------

.. autoapisummary::

   opendrift.logger
   opendrift.__version__
   opendrift.test_data_folder
   opendrift._available_models


Functions
---------

.. autoapisummary::

   opendrift.get_model_names
   opendrift.get_model
   opendrift.open
   opendrift.versions
   opendrift.import_from_ladim


Package Contents
----------------

.. py:data:: logger

.. py:data:: __version__
   :value: '1.14.2'


.. py:data:: test_data_folder

.. py:data:: _available_models
   :value: ['leeway.Leeway', 'openoil.OpenOil', 'larvalfish.LarvalFish', 'plastdrift.PlastDrift',...


.. py:function:: get_model_names()

.. py:function:: get_model(model_name)

.. py:function:: open(filename)

   Import netCDF output file as OpenDrift object of correct class


.. py:function:: versions()

.. py:function:: import_from_ladim(ladimfile, romsfile)

   Import Ladim output file as OpenDrift simulation obejct