.. FluidDyn documentation master file, created by
   sphinx-quickstart on Sun Mar  2 12:15:31 2014.

Fluidsim_ocean documentation
============================

.. warning ::

   Our repositories in Bitbucket.org will soon be deleted! Our new home:
   https://foss.heptapod.net/fluiddyn (`more details
   <https://fluiddyn.readthedocs.io/en/latest/advice_developers.html>`_).

The Python package Fluidsim_ocean will provide solvers useful for studying the
oceanic dynamics implemented using the CFD framework `fluidsim
<http://fluidsim.readthedocs.org>`_.

A general presentation of the equations and the solvers can be found here:

.. toctree::
   :maxdepth: 1

   equations-solvers

For the equations for the particular solvers, have a look at the documentation of
the solvers in the Modules Reference below.

Fluidsim is a framework for studying fluid dynamics with numerical
simulations using Python. It is part of the wider project `FluidDyn
<http://fluiddyn.readthedocs.io>`_.

Installation
------------

For simple setup, ``pip install fluidsim_ocean`` will work.

If you care about performance, first install `fluidsim
<http://fluidsim.readthedocs.org>`_ and then, get the source code of
fluidsim_ocean from `Heptapod <https://foss.heptapod.net/fluiddyn/fluidsim_ocean>`__
and install with::

  python setup.py develop

Modules Reference
-----------------

.. autosummary::
   :toctree: generated/

   fluidsim_ocean.sw2l
   fluidsim_ocean.time_stepping

More
----

.. toctree::
   :maxdepth: 1

   changes
   Advice for FluidDyn developers <http://fluiddyn.readthedocs.io/en/latest/advice_developers.html>
   authors
   to_do

Links
-----

.. |release| image:: https://img.shields.io/pypi/v/fluidsim_ocean.svg
   :target: https://pypi.org/project/fluidsim_ocean/
   :alt: Latest version

.. |coverage| image:: https://codecov.io/gh/fluiddyn/fluidsim_ocean/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/fluiddyn/fluidsim_ocean
   :alt: Code coverage

- `FluidDyn documentation <http://fluiddyn.readthedocs.io>`_
- `Fluidsim_ocean forge on Heptapod <https://foss.heptapod.net/fluiddyn/fluidsim_ocean>`_
- Fluidsim_ocean in PyPI |release|
- Unittest coverage |coverage|
- `FluidDyn user chat room
  <https://riot.im/app/#/room/#fluiddyn-users:matrix.org>`_
- `FluidDyn mailing list <https://www.freelists.org/list/fluiddyn>`_
- `FluidDyn on Twitter <https://twitter.com/pyfluiddyn>`_


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`