.. swerve documentation master file, created by
   sphinx-quickstart on Mon Feb 20 11:16:02 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to swerve's documentation!
==================================

**S**\hallow **W**\ater **E**\quations for **R**\elati **V**\istic **E**\nvironments

``swerve`` is a set of software designed to investigate the general relativistic form of the shallow water equations. The code is developed in the notebook ``Shallow_Water_Equations.ipynb``, before being implemented in an optimized C++/CUDA version which runs on the GPU. MPI is used to run the code on multiple GPUs (if available).

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

   README.rst
   input_file.rst
   classes.rst




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

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