Skip to content

Update pycmap_depth_profile.rst #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MSchatzUW wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update pycmap_depth_profile.rst #72

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3631b9
Update pycmap_depth_profile.rst
MSchatzUW May 20, 2020
6d7573b
Update pycmap_depth_profile.rst
MSchatzUW May 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions user_guide/API_ref/pycmap_api/data_vizualization/pycmap_depth_profile.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Depth Profile
python list. One may use the returned objects to modify the graph
properties.

..COMMENT: I think you want the above hyperlink to direct user to the API methods page.

.. note::
This method requires a valid `API key`_. It is not necessary to set the
Expand Down Expand Up @@ -71,17 +72,16 @@ Depth Profile
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.




:returns: list of graph objects
:returns: A list of graph objects.

A list of graph objects. Below are the graph's properties and methods.
Below are the graph's properties and methods.

:Properties:
**data: dataframe**
Expand All @@ -107,7 +107,7 @@ Depth Profile

|

Example:
Example
--------

This example compares the depth profile of chlorophyll concentration
Expand Down Expand Up @@ -170,7 +170,7 @@ Here is how to achieve the same results using a direct SQL statement. Please ref

EXEC uspDepthProfile 'tableName', 'variable', 'dt1', 'dt2', 'lat1', 'lat2', 'lon1', 'lon2', 'depth1', 'depth2'

**Example:**
**Example**

.. code-block:: sql

Expand Down