Documentation

There are two main sources for documentation:

1. Automatically generated documentation

A Doxygen-based documentation is available on https://gitlab.inria.fr/sweet/sweet-doc.

This documentation is mainly about the source code

2. Within the SWEET source itself

There is plenty of documentation in the ./doc folder in the SWEET repository. Please have a look at this directory first:

SWEET

• Continuous testing $\rightarrow$ /doc/sweet/continuous_testing
  Information about continuous testing

• Software development discussions $\rightarrow$ /doc/sweet/software_development_discussions
  Various information about why SWEET looks as it is

MULE

MULE is at the heart of SWEET - if you let it in!
It cares about automatic job script generation, generation of job scripts on super computers (if platforms are written properly), it cares about postprocessing and many more things. Check out the documentation!

/doc/MULE/

Time integration

There’s plenty of information available about the different time integration methods, see /doc/time_integration

PDE specific information

So far there’s only information available for the shallow-water equations. Check out /doc/pdes