more documentation

yoctoyotta1024 · Nov 23, 2023 · fd64667 · fd64667
1 parent 5df19b9
commit fd64667
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 6 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -6,7 +6,7 @@
 Author: Clara Bayley (CB)
 Additional Contributors:
 -----
-Last Modified: Monday 20th November 2023
+Last Modified: Thursday 23rd November 2023
 Modified By: CB
 -----
 License: BSD 3-Clause "New" or "Revised" License
@@ -53,6 +53,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.duration',
+    'sphinx_copybutton',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -23,7 +23,9 @@ To jump straight in, check out the
    :maxdepth: 1
    :caption: Contents:
 
+   intro/introduction
    usage/installation
+   usage/examples
    usage/quickstart
 
    pySD/pySD

diff --git a/docs/source/intro/introduction.rst b/docs/source/intro/introduction.rst
@@ -0,0 +1,4 @@
+Introduction
+============
+
+This is the motivation behind CLEO.
diff --git a/docs/source/usage/examples.rst b/docs/source/usage/examples.rst
@@ -0,0 +1,36 @@
+.. _examples:
+
+Examples
+========
+
+There are several test cases for CLEO, each with different builds,
+domains, microphysics, coupling, superdroplet motion etc. They can be 
+found in the ``CLEO/examples`` directory.
+
+1) Adiabatic Parcel
+-------------------
+a) Cusp Bifurcation
+###################
+
+b) Arabas and Shima 2017
+########################
+
+
+2) Box Model Collisions
+-----------------------
+a) Golovin
+##########
+
+b) Long
+#######
+
+c) Low and List
+###############
+
+
+3) Divergence Free Motion
+-------------------------
+
+
+4) Constant 2-D Thermodynamics 
+------------------------------
diff --git a/docs/source/usage/installation.rst b/docs/source/usage/installation.rst
@@ -3,7 +3,19 @@
 Installation
 ============
 
-First clone the github repository:
+First clone CLEO's github repository:
+
+
 .. code-block:: console
 
   $ git clone https://github.com/yoctoyotta1024/CLEO.git
+
+It’s not essential, but everything will be much easier if you clone
+CLEO in your home directory. If you choose to do otherwise,
+you may have to change some paths in the bash and python scripts.
+
+
+That's it, you're done!
+
+
+Maybe now you want to run :ref:`some examples <examples>`...
diff --git a/docs/source/usage/quickstart.rst b/docs/source/usage/quickstart.rst
@@ -1,4 +1,4 @@
 Quickstart
 ==========
 
-To begin, first follow the steps to :ref:`install CLEO <installation>`.
+Start by following the steps to :ref:`install CLEO <installation>`.
diff --git a/setup.py b/setup.py
@@ -1,12 +1,12 @@
 '''
 ----- CLEO -----
 File: setup.py
-Project: CLEO
+Project: CLEOfire
 Created Date: Thursday 12th October 2023
 Author: Clara Bayley (CB)
 Additional Contributors:
 -----
-Last Modified: Friday 3rd November 2023
+Last Modified: Thursday 23rd November 2023
 Modified By: CB
 -----
 License: BSD 3-Clause "New" or "Revised" License
@@ -19,7 +19,7 @@
 from setuptools import setup, find_packages
 
 setup(
-    name='CLEO 4.0',
+    name='CLEO',
     version='4.0',
     packages=find_packages(),
     install_requires=[