Skip to content

Commit 06fe891

Browse files
kan-fukan-fu
committed
doc: update documentation content
1 parent 81fbb0a commit 06fe891

15 files changed

+752
-528
lines changed

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -150,3 +150,6 @@ dmypy.json
150150

151151
# commit-msg hook
152152
commit-msg
153+
154+
# Mac OS specfic
155+
.DS_Store

‎doc/source/Code_Examples/Discover_Data_Products.ipynb

+25-39
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,14 @@
3232
"cell_type": "markdown",
3333
"metadata": {},
3434
"source": [
35-
"## Get all data product extensions\n"
35+
"## [/dataProducts](https://data.oceannetworks.ca/OpenAPI#get-/dataProducts)\n"
36+
]
37+
},
38+
{
39+
"cell_type": "markdown",
40+
"metadata": {},
41+
"source": [
42+
"### Get all data products and their individual parameters from Oceans 3.0\n"
3643
]
3744
},
3845
{
@@ -48,9 +55,9 @@
4855
"cell_type": "markdown",
4956
"metadata": {},
5057
"source": [
51-
"## Get the data product extensions for a specific data product code\n",
58+
"### Get the data product options that are available for a specific data product code\n",
5259
"\n",
53-
"Return all data product extensions for the _dataProductCode_ \"TSSD\" (\"Time Series Scalar Data\").\n"
60+
"Return all data product options for the _dataProductCode_ \"**TSSD**\" (\"Time Series Scalar Data\").\n"
5461
]
5562
},
5663
{
@@ -69,9 +76,9 @@
6976
"cell_type": "markdown",
7077
"metadata": {},
7178
"source": [
72-
"## Get all data product extensions available for a specific extension\n",
79+
"### Get all data product options that are available with a specific file extension\n",
7380
"\n",
74-
"Return all data product extensions which are available for the _extension_ \"pdf\".\n"
81+
"Return all data product options which are available for the _extension_ \"**pdf**\".\n"
7582
]
7683
},
7784
{
@@ -90,9 +97,9 @@
9097
"cell_type": "markdown",
9198
"metadata": {},
9299
"source": [
93-
"## Get all data product extensions available for a specific data product code and specific extension\n",
100+
"### Get all data product options available for a specific data product code and specific file extension\n",
94101
"\n",
95-
"Return all data product extensions which are available for the _dataProductCode_ \"TSSD\" and _extension_ \"csv\".\n"
102+
"Return all data product options which are available for the _dataProductCode_ \"**TSSD**\" and _extension_ \"**csv**\".\n"
96103
]
97104
},
98105
{
@@ -112,9 +119,9 @@
112119
"cell_type": "markdown",
113120
"metadata": {},
114121
"source": [
115-
"## Get all data product extensions which have a certain word in the name\n",
122+
"### Get all data product options which have a certain word in the data product name\n",
116123
"\n",
117-
"Return all data product extensions which have \"scalar\" in the name.\n"
124+
"Return all data product options which have \"**scalar**\" in the name.\n"
118125
]
119126
},
120127
{
@@ -133,9 +140,9 @@
133140
"cell_type": "markdown",
134141
"metadata": {},
135142
"source": [
136-
"## Get all data product extensions that are available at a specific location\n",
143+
"### Get all data product options that are available at a specific location on ONCs network\n",
137144
"\n",
138-
"Return all data product extensions that are available at the location with the _locationCode_ \"BACAX\" (\"Barkley Canyon Axis (POD1)\").\n"
145+
"Return all data product options that are available at the location with the _locationCode_ \"**BACAX**\" (\"Barkley Canyon Axis (POD1)\").\n"
139146
]
140147
},
141148
{
@@ -154,9 +161,9 @@
154161
"cell_type": "markdown",
155162
"metadata": {},
156163
"source": [
157-
"## Get all data product extensions that are available for a specific extension at a specific location\n",
164+
"### Get all data product options that are available for a specific file extension at a specific locationCode\n",
158165
"\n",
159-
"Return all data product extensions that are available for the _extension_ \"mat\" at the location with the _locationCode_ \"BACAX\" (\"Barkley Canyon Axis (POD1)\").\n"
166+
"Return all data product options that are available for the _extension_ \"**mat**\" at the location with the _locationCode_ \"**BACAX**\" (\"Barkley Canyon Axis (POD1)\").\n"
160167
]
161168
},
162169
{
@@ -176,9 +183,9 @@
176183
"cell_type": "markdown",
177184
"metadata": {},
178185
"source": [
179-
"## Get all data product codes that are available on a specific deployed device\n",
186+
"### Get all data products and their filter parameter options that are available on a specific deployed device\n",
180187
"\n",
181-
"Return all data product codes available for a device with the _deviceCode_ \"NORTEKAQDPRO8398\".\n"
188+
"Return all data product codes available for a device with the _deviceCode_ \"**NORTEKAQDPRO8398**\".\n"
182189
]
183190
},
184191
{
@@ -197,30 +204,9 @@
197204
"cell_type": "markdown",
198205
"metadata": {},
199206
"source": [
200-
"## Get all data product extensions with a specific property\n",
201-
"\n",
202-
"Return all data product extensions which have the property \"seawatertemperature\".\n"
203-
]
204-
},
205-
{
206-
"cell_type": "code",
207-
"execution_count": null,
208-
"metadata": {},
209-
"outputs": [],
210-
"source": [
211-
"params = {\n",
212-
" \"propertyCode\": \"seawatertemperature\",\n",
213-
"}\n",
214-
"onc.getDataProducts(params)"
215-
]
216-
},
217-
{
218-
"cell_type": "markdown",
219-
"metadata": {},
220-
"source": [
221-
"## Get all data product extensions that are available for a specific device category\n",
207+
"### Get all data product options that are available for a specific device category\n",
222208
"\n",
223-
"Return all data product extensions which are available for the _deviceCategoryCode_ \"ADCP 150 kHz\".\n"
209+
"Return all data product options which are available for the _deviceCategoryCode_ \"**ADCP150KHZ**\".\n"
224210
]
225211
},
226212
{
@@ -252,7 +238,7 @@
252238
"name": "python",
253239
"nbconvert_exporter": "python",
254240
"pygments_lexer": "ipython3",
255-
"version": "3.10.6"
241+
"version": "3.10.12"
256242
},
257243
"mystnb": {
258244
"remove_code_outputs": true

‎doc/source/Code_Examples/Discover_Deployments.ipynb

+18-27
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
},
1010
{
1111
"cell_type": "code",
12-
"execution_count": null,
12+
"execution_count": 3,
1313
"metadata": {},
1414
"outputs": [],
1515
"source": [
@@ -32,25 +32,16 @@
3232
"cell_type": "markdown",
3333
"metadata": {},
3434
"source": [
35-
"## Get all deployments\n"
36-
]
37-
},
38-
{
39-
"cell_type": "code",
40-
"execution_count": null,
41-
"metadata": {},
42-
"outputs": [],
43-
"source": [
44-
"onc.getDeployments()"
35+
"## [/deployments](https://data.oceannetworks.ca/OpenAPI#get-/deployments)\n"
4536
]
4637
},
4738
{
4839
"cell_type": "markdown",
4940
"metadata": {},
5041
"source": [
51-
"## Get all deployments for a specific device code\n",
42+
"### Get all deployments for a specific device code\n",
5243
"\n",
53-
"Return the deployments for the device with the _deviceCode_ \"NORTEKAQDPRO8398\".\n"
44+
"Return the deployments for the device with the _deviceCode_ \"**NORTEKAQDPRO8398**\".\n"
5445
]
5546
},
5647
{
@@ -69,9 +60,9 @@
6960
"cell_type": "markdown",
7061
"metadata": {},
7162
"source": [
72-
"## Get all deployments at a specific location\n",
63+
"### Get all deployments at a specific location\n",
7364
"\n",
74-
"Return all deployments at the location with the _locationCode_ \"BACAX\".\n"
65+
"Return all deployments at the location with the _locationCode_ \"**BACAX**\".\n"
7566
]
7667
},
7768
{
@@ -90,9 +81,9 @@
9081
"cell_type": "markdown",
9182
"metadata": {},
9283
"source": [
93-
"## Get all deployments with a specific device category\n",
84+
"### Get all deployments with a specific device category\n",
9485
"\n",
95-
"Return all deployments with the _deviceCategoryCode_ \"ADCP2MHZ\".\n"
86+
"Return all deployments with the _deviceCategoryCode_ \"**ADCP2MHZ**\".\n"
9687
]
9788
},
9889
{
@@ -111,9 +102,9 @@
111102
"cell_type": "markdown",
112103
"metadata": {},
113104
"source": [
114-
"## Get all deployments with a specific property\n",
105+
"### Get all deployments with a specific property\n",
115106
"\n",
116-
"Return all deployments with instruments that measure the property \"oxygen\".\n"
107+
"Return all deployments with instruments that measure the property \"**oxygen**\".\n"
117108
]
118109
},
119110
{
@@ -132,9 +123,9 @@
132123
"cell_type": "markdown",
133124
"metadata": {},
134125
"source": [
135-
"## Get all deployments with a specific device category and a specific property\n",
126+
"### Get all deployments with a specific device category and a specific property\n",
136127
"\n",
137-
"Return all deployments that have devices with the device category \"CTD\" and property \"pressure\".\n"
128+
"Return all deployments that have devices with the device category \"**CTD**\" and property \"**pressure**\".\n"
138129
]
139130
},
140131
{
@@ -154,7 +145,7 @@
154145
"cell_type": "markdown",
155146
"metadata": {},
156147
"source": [
157-
"## Get all deployments between two dates\n",
148+
"### Get all deployments between two dates\n",
158149
"\n",
159150
"Return all deployments between 1 July 2010 and 30 June 2011. Check [here](https://wiki.oceannetworks.ca/display/O2A/Glossary+of+Terms#GlossaryofTerms-ISO8601Duration) for additional information about the supported dates/times format.\n"
160151
]
@@ -176,9 +167,9 @@
176167
"cell_type": "markdown",
177168
"metadata": {},
178169
"source": [
179-
"## Get all deployments at a specific location, between two dates\n",
170+
"### Get all deployments at a specific location, between two dates\n",
180171
"\n",
181-
"Return all deployments between 1 July 2010 and 30 June 2011, at the location with the _locationCode_ \"BACAX\" (\"Barkely Canyon Axis (POD1)\").\n"
172+
"Return all deployments between 1 July 2010 and 30 June 2011, at the location with the _locationCode_ \"**BACAX**\" (\"Barkely Canyon Axis (POD1)\").\n"
182173
]
183174
},
184175
{
@@ -199,9 +190,9 @@
199190
"cell_type": "markdown",
200191
"metadata": {},
201192
"source": [
202-
"## Get all deployments at a specific location, between two dates, with a sensor with a specific property code\n",
193+
"### Get all deployments at a specific location, between two dates, with a sensor with a specific property code\n",
203194
"\n",
204-
"Return all deployments between 1 July 2010 and 30 June 2011, at the location with the _locationCode_ \"BACAX\" (\"Barkely Canyon Axis (POD1)\"), with the _propertyCode_ \"seawatertemperature\".\n"
195+
"Return all deployments between 1 July 2010 and 30 June 2011, at the location with the _locationCode_ \"**BACAX**\" (\"Barkely Canyon Axis (POD1)\"), with the _propertyCode_ \"**seawatertemperature**\".\n"
205196
]
206197
},
207198
{
@@ -236,7 +227,7 @@
236227
"name": "python",
237228
"nbconvert_exporter": "python",
238229
"pygments_lexer": "ipython3",
239-
"version": "3.10.6"
230+
"version": "3.10.12"
240231
},
241232
"mystnb": {
242233
"remove_code_outputs": true

‎doc/source/Code_Examples/Discover_Device_Categories.ipynb

+19-12
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,14 @@
3232
"cell_type": "markdown",
3333
"metadata": {},
3434
"source": [
35-
"## Get all device categories\n"
35+
"## [/deviceCategories](https://data.oceannetworks.ca/OpenAPI#get-/deviceCategories)\n"
36+
]
37+
},
38+
{
39+
"cell_type": "markdown",
40+
"metadata": {},
41+
"source": [
42+
"### Get all device categories\n"
3643
]
3744
},
3845
{
@@ -48,9 +55,9 @@
4855
"cell_type": "markdown",
4956
"metadata": {},
5057
"source": [
51-
"## Get the device category for a specific device category code\n",
58+
"### Get the device category for a specific device category code\n",
5259
"\n",
53-
"Return the device category for the _deviceCategoryCode_ \"ADCP150KHZ\".\n"
60+
"Return the device category information for the _deviceCategoryCode_ \"**ADCP150KHZ**\".\n"
5461
]
5562
},
5663
{
@@ -69,9 +76,9 @@
6976
"cell_type": "markdown",
7077
"metadata": {},
7178
"source": [
72-
"## Get all device categories which have a certain word in the name\n",
79+
"### Get all device categories which have a certain word in the name\n",
7380
"\n",
74-
"Return all device categories which have \"acoustic\" in the name.\n"
81+
"Return all device categories which have \"**acoustic**\" in the name.\n"
7582
]
7683
},
7784
{
@@ -90,9 +97,9 @@
9097
"cell_type": "markdown",
9198
"metadata": {},
9299
"source": [
93-
"## Get all device categories which have a certain word in the description\n",
100+
"### Get all device categories which have a certain word in the description\n",
94101
"\n",
95-
"Return all device categories which have \"doppler\" in the description.\n"
102+
"Return all device categories which have \"**doppler**\" in the description.\n"
96103
]
97104
},
98105
{
@@ -111,9 +118,9 @@
111118
"cell_type": "markdown",
112119
"metadata": {},
113120
"source": [
114-
"## Get all device categories that are available at a specific location\n",
121+
"### Get all device categories that are available at a specific location\n",
115122
"\n",
116-
"Return all device categories that are available at the location with the _locationCode_ \"BACAX\" (\"Barkley Canyon Axis (POD1)\").\n"
123+
"Return all device categories that are available at the location with the _locationCode_ \"**BACAX**\" (\"Barkley Canyon Axis (POD1)\").\n"
117124
]
118125
},
119126
{
@@ -132,9 +139,9 @@
132139
"cell_type": "markdown",
133140
"metadata": {},
134141
"source": [
135-
"## Get all the device categories which have devices that have a specific property\n",
142+
"### Get all the device categories which have devices that have a specific property\n",
136143
"\n",
137-
"Return all device categories which have devices with the property \"salinity\".\n"
144+
"Return all device categories which have devices with the propertyCode \"**salinity**\".\n"
138145
]
139146
},
140147
{
@@ -166,7 +173,7 @@
166173
"name": "python",
167174
"nbconvert_exporter": "python",
168175
"pygments_lexer": "ipython3",
169-
"version": "3.10.6"
176+
"version": "3.11.7"
170177
},
171178
"mystnb": {
172179
"remove_code_outputs": true

0 commit comments

Comments
 (0)