Merge branch 'MSchatzUW/patch-38'

simonscmap · May 4, 2020 · 41a94c6 · 41a94c6
2 parents 41eb7ca + c74cc7f
commit 41a94c6
Showing 1 changed file with 15 additions and 33 deletions.
diff --git a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_depth_profile.rst b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_depth_profile.rst
@@ -15,9 +15,9 @@ Depth Profile
    :target: https://mybinder.org/v2/gh/simonscmap/pycmap/master?filepath=docs%2FViz_DepthProfile.ipynb
 
 
-.. _API key: pycmap_api.html
-.. _APIs parameters: pycmap_api.html
-.. _APIs vizEngine: pycmap_api.html
+.. _API key: https://cmap.readthedocs.io/en/latest/user_guide/API_ref/pycmap_api/pycmap_api_ref.html
+.. _APIs parameters: https://cmap.readthedocs.io/en/latest/user_guide/API_ref/pycmap_api/pycmap_api_ref.html
+.. _`APIs vizEngine`: https://cmap.readthedocs.io/en/latest/user_guide/API_ref/pycmap_api/pycmap_api_ref.html
 
 
 .. method:: plot_depth_profile(tables, variables, dt1, dt2, lat1, lat2, lon1, lon2, depth1, depth2, exportDataFlag=False, show=True)
@@ -37,6 +37,7 @@ Depth Profile
     python list. One may use the returned objects to modify the graph
     properties.
 
+
     .. note::
       This method requires a valid `API key`_. It is not necessary to set the
       API key every time because the API properties are stored locally after
@@ -53,23 +54,24 @@ Depth Profile
             Variable short name which directly corresponds to a field name in the table. A full list of variable short names can be found in :ref:`Catalog`.
         **dt1: string**
             Start date or datetime. This parameter sets the lower bound of the temporal cut.
-            Example values: '2016-05-25' or '2017-12-10 17:25:00'
+            Example values: '2016-05-25' or '2017-12-10 17:25:00'.
         **dt2: string**
-            End date or datetime. This parameter sets the upper bound of the temporal cut.
+            End date or datetime. This parameter sets the upper bound of the temporal cut. Example values: '2016-05-25' or '2017-12-10 17:25:00'.
         **lat1: float**
             Start latitude [degree N]. This parameter sets the lower bound of the meridional cut. Note latitude ranges from -90° to 90°.
         **lat2: float**
             End latitude [degree N]. This parameter sets the upper bound of the meridional cut. Note latitude ranges from -90° to 90°.
         **lon1: float**
-            Start longitude [degree E]. This parameter sets the lower bound of the zonal cut. Note latitude ranges from -180° to 180°.
+            Start longitude [degree E]. This parameter sets the lower bound of the zonal cut. Note longitude ranges from -180° to 180°.
         **lon2: float**
-            End longitude [degree E]. This parameter sets the upper bound of the zonal cut. Note latitude ranges from -180° to 180°.
+            End longitude [degree E]. This parameter sets the upper bound of the zonal cut. Note longitude ranges from -180° to 180°.
         **depth1: float**
-            Start depth [m]. This parameter sets the lower bound of the vertical cut. Note depth is a positive number (it is 0 at surface and grows towards ocean floor).
+            Start depth [m]. This parameter sets the lower bound of the vertical cut. Note depth is a positive number (it is 0 at the surface and increases towards the ocean floor).
         **depth2: float**
-            End depth [m]. This parameter sets the upper bound of the vertical cut. Note depth is a positive number (it is 0 at surface and grows towards ocean floor).
+            End depth [m]. This parameter sets the upper bound of the vertical cut. Note depth is a positive number (it is 0 at the surface and increases towards the ocean floor).
         **exportDataFlag: boolean, default: False**
           If True, the graph data points are stored on the local machine. The export path and file format are set by the `APIs parameters`_.
+
         **show: boolean, default: True**
           If True, the graph object is returned and is displayed. The graph file is saved on the local machine at the figureDir directory.
           If False, the graph object is returned but not displayed.
@@ -78,6 +80,7 @@ Depth Profile
 
 
     :returns\:: list of graph objects
+
       A list of graph objects. Below are the graph's properties and methods.
 
       :Properties:
@@ -92,11 +95,11 @@ Depth Profile
         **width: int**
           Graph's width in pixels.
         **xlabel: str**
-          The graphs's x-axis label.
+          Graphs's x-axis label.
         **ylabel: str**
-          The graphs's y-axis label.
+          Graphs's y-axis label.
         **title: str**
-          The graphs's title.
+          Graphs's title.
 
     :Methods:
       **render()**
@@ -155,27 +158,6 @@ changed by: ``pycmap.API(vizEngine='bokeh')``
 
 
 
-.. code-block:: python
-
-  # here is how to modify a graph:
-
-  go[1].cmap = 'PRGn'
-  go[1].vmin = 0
-  go[1].vmax = 5e-5
-  go[1].width = 900
-  go[1].height = 700
-  go[1].render()
-
-|
-
-.. raw:: html
-
-   <iframe src="../../../../_static/pycmap_tutorial_viz/html/depth_profile_modified_argo_merge_chl_adj.html"  frameborder = 0  height="650px" width="100%">></iframe>
-
-
-
-
-
 
 .. figure:: /_static/overview_icons/sql.png
   :scale: 10 %