Skip to content

Commit

Permalink
Merge pull request #97 from axch/general-doc-touchups
Browse files Browse the repository at this point in the history
General doc touchups
  • Loading branch information
edoddridge authored Apr 18, 2017
2 parents 9051481 + d19e0a0 commit 6440c60
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/about_aronnax.rst → docs/aronnax_model.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
About Aronnax
The Aronnax Model
********************

The Physics
Expand Down
37 changes: 33 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,46 @@
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
=======

Aronnax is an idealised and easily configurable isopycnal model. The numerical core is written in Fortran, but it is wrapped in Python.
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 <aronnax_model.html#the-physics>`_
and `the numerics <aronnax_model.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
aronnax_model
input_generation
output_helpers
verification
Expand Down

0 comments on commit 6440c60

Please sign in to comment.