doc: added quickbuild.sh usage to compiling dart

added note on quickbuild.sh help to getting started
NCAR · Nov 6, 2023 · 4fb221f · 4fb221f
1 parent d5b3779
commit 4fb221f
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/guide/compiling-dart.rst b/guide/compiling-dart.rst
@@ -10,6 +10,28 @@ To build DART executables you will need to
    For example, if you want to build DART for the lorenz_63 model, ``cd DART/models/lorenz_63/work``
 #. Build the DART executables with ``./quickbuild.sh``
 
+   .. code-block:: text
+   
+    Usage:
+     quickbuild.sh                     : build everything
+     quickbuild.sh clean               : clean the build
+     quickbuild.sh help                : print help message
+   
+     quickbuild.sh [nompi/nompi/mpif08] [program]   : optional arguments
+                                                      [mpi]     build with mpi (default)
+                                                      [nompi]   build without mpi
+                                                      [mpif08]  build with mpi using mpi_f08
+                                                      [program] build a single program
+   
+     Example 1. Build filter without mpi:
+              quickbuild.sh nompi filter
+   
+     Example 2. Build perfect_model_obs with mpi
+              quickbuild.sh perfect_model_obs
+   
+     Example 3. Build perfect_model_obs with mpi using the mpi_f08 bindings
+              quickbuild.sh mpif08 perfect_model_obs
+
 
 For more detail on how quickbuild.sh works see :ref:`DART build system`.
 

diff --git a/index.rst b/index.rst
@@ -121,6 +121,8 @@ If you are planning to run one of the larger models and want to use the Lorenz
 63 model as a test, run ``./quickbuild.sh``. It will build filter and any
 other MPI-capable executables with MPI.
 
+``./quickbuild.sh help`` will print out the quickbuild.sh usage.
+
 .. important::
 
    The ``mpif90`` command you use must have been built with the same version of