From a2af4a2db3ff2ef0bcffd6b8d1d493d6795a9f72 Mon Sep 17 00:00:00 2001
From: Andrew Moodie <amoodie@rice.edu>
Date: Mon, 8 Jun 2020 09:31:38 -0400
Subject: [PATCH] add py high level api docs

---
 docs/source/guides/userguide.rst | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

diff --git a/docs/source/guides/userguide.rst b/docs/source/guides/userguide.rst
index 3ad6d355..a2a8acaa 100644
--- a/docs/source/guides/userguide.rst
+++ b/docs/source/guides/userguide.rst
@@ -72,7 +72,20 @@ If the YAML configuration indicates multiple jobs (:ref:`via matrix expansion or
 Python API
 ----------
 
-Alternatively, calling the ``run_model`` method from a python script, with the :meth:`input file <pyDeltaRCM.model.DeltaModel.__init__>` parameter specified as the same ``model_configuration.yml`` file above, would run the pyDeltaRCM model, and automatically :obj:`~pyDeltaRCM.model.DeltaModel.update` the model 500 times.
+The Python high-level API is accessed via the :obj:`~pyDeltaRCM.Preprocessor` object. 
+First, the `Preprocessor` is instantiated with a YAML configuration file (e.g., ``model_configuration.yml``):
+
+.. code::
+
+    >>> pp = preprocessor.Preprocessor(p)
+    
+which returns an object containing the list of jobs to run. 
+Jobs are then run with:
+
+.. code::
+
+    >>> pp.run_jobs()
+
 
 
 Low-level model API
@@ -82,12 +95,12 @@ iinteract with the model by creating your own script, and manipulating model out
 
 .. code::
 
-    delta = DeltaModel(input_file='model_configuration.yml')
+    >>> delta = DeltaModel(input_file='model_configuration.yml')
 
-    for _ in range(0, 1):
-        delta.update()
+    >>> for _ in range(0, 1):
+    ...    delta.update()
 
-    delta.finalize()
+    >>> delta.finalize()
 
 However, you can also inspect/modify the :obj:`~pyDeltaRCM.DeltaModel.update` method, and change the order of operations, or add operations, as desired.