Add cross-ref to preprocessor

CADWRDeltaModeling · Mar 1, 2024 · bcf2e44 · bcf2e44
1 parent cc49aa4
commit bcf2e44
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 5 deletions.
diff --git a/docsrc/index.rst b/docsrc/index.rst
@@ -23,9 +23,9 @@ To use schimpy tools in a project::
 
     import schimpy
 	
-Many schimpy utilities can be invoked as command line utilities and the most common of these is the `prepare_schism` command for the `preprocessor`_ ::
+Many schimpy utilities can be invoked as command line utilities and the most common of these is the `prepare_schism` command for the `preprocessor`_ invoked like this::
 
-	$ prepare_schism main_bay_delta.yaml 
+    $ prepare_schism main_bay_delta.yaml 
 
 where `main_bay_delta.yaml` is the main yaml input file for your project.
 

diff --git a/docsrc/preprocessing.rst b/docsrc/preprocessing.rst
@@ -2,13 +2,21 @@
 .. _preprocessor:
 
 Preprocessing
-==============
+=============
 
 Invoking the preprocessor
 -------------------------
 
-prepare_SCHISM.py
-^^^^^^^^^^^^^^^^^
+The preprocessor can prepare and manipulate many components of the SCHISM input. 
+It is usually invoked using a command like this::
+
+    $ prepare_schism main_bay_delta.yaml
+	
+The contents of main_bay_delta.yaml are discussed below. Industrial strength samples, used as the point of departure for most applied projects, are available in the `templates` directory of BayDeltaSCHISM distribution.
+
+
+prepare_schism
+^^^^^^^^^^^^^^
 
 .. argparse::
     :module: schimpy.prepare_schism