Per #3, modifying structure of files for the Table of Contents

NCAR · Feb 27, 2024 · 948f4a1 · 948f4a1
1 parent 49fea44
commit 948f4a1
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 2 deletions.
diff --git a/docs/Tutorial/cases/cases.rst b/docs/Tutorial/cases/cases.rst
@@ -0,0 +1,12 @@
+****************
+Ideal Test Cases
+****************
+
+Four test cases are described:
+
+* Dry neutral boundary layer
+* Dry convective boundary layer
+* Dry stable boundary layer
+* Moist cloud-topped boundary layer
+
+Required tutorial resources including input files, python utilities and Jupyter Notebooks are provided in https://github.com/NCAR/FastEddy-tutorials. All test cases are ideal setups over zero terrain. For each case, the user will set up the input parameter file, execute FastEddy, visualize the output using a Jupyter notebook, and perform some basic analysis of the output. After examining the test cases, the user will carry out some sensitivity tests by changing various input parameters. The purpose of these tests are for the user to become more familiar with the input parameters, and how changes to those parameters affect the output. After the tutorial, the user is expected to have basic knowledge to carry out LES using FastEddy.
diff --git a/docs/Tutorial/getting_started.rst b/docs/Tutorial/getting_started.rst
@@ -0,0 +1,22 @@
+***************
+Getting Started
+***************
+
+Introduction
+============
+
+`FastEddy`_ is a resident-GPU large eddy simulation (LES) model owned by the National Center for Atmospheric Research (`NCAR`_) Research Applications Laboratory (`RAL`_). It is designed for future turbulence-resolving numerical weather prediction. 
+
+.. _FastEddy: https://ral.ucar.edu/solutions/products/fasteddy
+.. _NCAR: https://ncar.ucar.edu
+.. _RAL: https://ral.ucar.edu
+
+This is a tutorial designed so that a user can learn how to execute FastEddy, using the four test cases described in this tutorial. 
+
+
+Software and computing requirements
+===================================
+
+Computing resources with at least four general purpose graphics processing units are recommended to carry out the test cases. System must be enabled with python and Jupyter notebook packages. Add other requirements (compilers, libraries, etc).
+
+Instructions on how to build and run FastEddy on NCAR's Casper architecture https://github.com/NCAR/FastEddy-model/blob/main/README.md.
diff --git a/docs/Tutorial/index.rst b/docs/Tutorial/index.rst
@@ -7,6 +7,7 @@
    :caption: IDEAL TEST CASES 
    :numbered:
 
+   cases/cases.rst
    cases/NBL.rst
    cases/CBL.rst
    cases/SBL.rst

diff --git a/docs/Tutorial/sensitivity.rst b/docs/Tutorial/sensitivity.rst
@@ -1,6 +1,9 @@
-************
+*****************
+Sensitivity Tests
+*****************
+
 Instructions
-************
+============
 
 * Re-run the neutral case with :math:`[N_x,N_y,N_z]=[400,400,122]` and isotropic grid spacings of :math:`[dx,dy,dz]=[10,10,10]`. Adjust the model time step accordingly. Re-make all plots and discuss the differences between the control case. How much longer did it take to complete the simulation? 
 * Re-run the convective case with a surface heat flux of :math:`=+0.70` Km/s. Re-make all plots and discuss the differences between the control case.