:py:mod:`opendrift`
===================

.. py:module:: opendrift

.. autoapi-nested-parse::

   Opendrift module

   .. currentmodule:: opendrift

   .. doctest::

       >>> import opendrift



Subpackages
-----------
.. toctree::
   :titlesonly:
   :maxdepth: 3

   elements/index.rst
   export/index.rst
   models/index.rst
   readers/index.rst


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   config/index.rst
   errors/index.rst
   timer/index.rst
   version/index.rst


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


Functions
~~~~~~~~~

.. autoapisummary::

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



Attributes
~~~~~~~~~~

.. autoapisummary::

   opendrift.logger
   opendrift.__version__
   opendrift._available_models


.. py:data:: logger

   

.. py:data:: __version__
   :value: '1.11.2'

   

.. 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, times=None, elements=None, load_history=True)

   Import netCDF output file as OpenDrift object of correct class


.. py:function:: open_xarray(filename, chunks={'trajectory': 50000, 'time': 1000}, elements=None)

   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