.. ValidatingCLEO documentation master file, based off sphinx-quickstart.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to ValidatingCLEO's Documentation!
==================================================

This repository has been made to document specific test cases of CLEO on
Levante for CLEO's second model description paper. Specifically it tests CLEO ``v0.39.7``.

To (locally) reproduce this project, simply clone the repository. You will need to setup an
environment with the dependencies installed and then run ``pre-commit install``, but other than
that everything should work out of the box and you can now run & have fun with the project...
If not, please raise an issue on the GitHub repository.

Time to get involved! Check out the :doc:`getting started page<usage/getstart>`.

Contents
--------
.. toctree::
   :maxdepth: 1

   usage/getstart
   testcases/condevap
   testcases/collisions
   usage/ourdocs

   GitHub Repo <https://github.com/yoctoyotta1024/ValidatingCLEO.git>
   usage/contributing
   usage/contact
   references

Questions?
----------
Yes please! Simply :ref:`contact us! <contact>`

Indices and tables
------------------

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