From ae24afc41a0b2d253d9eed292213f0a87dd728f7 Mon Sep 17 00:00:00 2001 From: Megan Schatz <63426274+MSchatzUW@users.noreply.github.com> Date: Wed, 20 May 2020 14:07:19 -0700 Subject: [PATCH 1/2] Update pycmap_time_series.rst Megan's edits and comments --- .../data_vizualization/pycmap_time_series.rst | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_time_series.rst b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_time_series.rst index e2bbeb3..46c5065 100644 --- a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_time_series.rst +++ b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_time_series.rst @@ -29,6 +29,8 @@ Time Series Plot python list. One may use the returned objects to modify the graph properties. +..COMMENT: APIs vizEngine appears to be a hyperlink but isn't. To make it a hyperlink I would direct it to the API methods page. + .. 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 @@ -47,21 +49,24 @@ Time Series Plot 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' **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`_. + +..COMMENT: I think you want the above hyperlink going to the API methods page. + **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. @@ -156,7 +161,7 @@ library (plotly) which may be changed by: - +..COMMENT: The label for the x axis isn't visable in the example below like it probably should be. .. code-block:: python From b1169eb39b97452ce4198ed2bf32493ddbff46e2 Mon Sep 17 00:00:00 2001 From: Megan Schatz <63426274+MSchatzUW@users.noreply.github.com> Date: Wed, 27 May 2020 21:56:39 -0700 Subject: [PATCH 2/2] Update pycmap_time_series.rst --- .../data_vizualization/pycmap_time_series.rst | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_time_series.rst b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_time_series.rst index 46c5065..5371525 100644 --- a/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_time_series.rst +++ b/user_guide/API_ref/pycmap_api/data_vizualization/pycmap_time_series.rst @@ -29,8 +29,6 @@ Time Series Plot python list. One may use the returned objects to modify the graph properties. -..COMMENT: APIs vizEngine appears to be a hyperlink but isn't. To make it a hyperlink I would direct it to the API methods page. - .. 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 @@ -63,10 +61,7 @@ Time Series Plot **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 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`_. - -..COMMENT: I think you want the above hyperlink going to the API methods page. - + 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. @@ -112,7 +107,7 @@ Time Series Plot | -**Example:** +**Example** This example generates two timeseries graphs showing remotly sensed `sea @@ -161,7 +156,7 @@ library (plotly) which may be changed by: -..COMMENT: The label for the x axis isn't visable in the example below like it probably should be. + .. code-block:: python