.. Aronnax documentation master file, created by
   sphinx-quickstart on Wed Apr  5 22:01:04 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Aronnax's documentation!
===================================

Aronnax is an idealised and easily configurable isopycnal model. The numerical core is written in Fortran, but it is wrapped in Python.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   about_aronnax
   examples
   input_generation
   output_helpers
   verification
   benchmarks


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

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

.. Aronnax documentation master file, created by
   sphinx-quickstart on Wed Apr  5 22:01:04 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Aronnax
=======

Aronnax is an idealised and easily configurable isopycnal ocean circulation model.
Aronnax can be run as either a reduced gravity model with n + 1/2 layers, or with n layers and variable bathymetry.

Aronnax is

- `Easy to install <https://github.com/edoddridge/aronnax#install>`_
  on a laptop or a compute node, including without
  administrative privileges.

- Easy to configure.  All parameters, including grid size, are
  specified at runtime in a simple configuration file.

- `Easy to use <examples.html>`_.
  Aronnax can be called as a simple command-line program
  that reads and writes the standard NetCDF data format, or can be
  controlled programmatically as a Python library, communicating data
  through Numpy arrays.

- Easy to learn and understand, with extensive online
  documentation, including a complete description of `the
  physics <about_aronnax.html#the-physics>`_
  and `the numerics <about_aronnax.html#discretisation>`_.

- `Verified <verification.html>`_.
  Aronnax successfully reproduces multiple published results from
  idealized models appearing in the literature.

- `Fast <benchmarks.html>`_.  The
  main integration loop is a multi-core Fortran program, wrapped in
  Python for convenient use.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   about_aronnax
   examples
   input_generation
   output_helpers
   verification
   benchmarks


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

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

Put the main ad into the docs landing page too.
Put the main ad into the docs landing page too.
