cdss-ruby 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.rubocop.yml +86 -0
- data/CHANGELOG.md +5 -0
- data/CODE_OF_CONDUCT.md +84 -0
- data/README.md +101 -0
- data/Rakefile +26 -0
- data/docs/Cdss/AdminCalls.html +399 -0
- data/docs/Cdss/Analysis.html +972 -0
- data/docs/Cdss/Client.html +581 -0
- data/docs/Cdss/Climate.html +1257 -0
- data/docs/Cdss/Concerns/LogReadingAttributes.html +406 -0
- data/docs/Cdss/Concerns/WellReadingAttributes.html +414 -0
- data/docs/Cdss/Concerns.html +117 -0
- data/docs/Cdss/GroundWater.html +945 -0
- data/docs/Cdss/Models/AdminCall.html +252 -0
- data/docs/Cdss/Models/Analysis.html +397 -0
- data/docs/Cdss/Models/CallAnalysis.html +140 -0
- data/docs/Cdss/Models/ClimateStation.html +249 -0
- data/docs/Cdss/Models/DiversionRecord.html +248 -0
- data/docs/Cdss/Models/Reading.html +301 -0
- data/docs/Cdss/Models/ReferenceTable.html +339 -0
- data/docs/Cdss/Models/RouteAnalysis.html +140 -0
- data/docs/Cdss/Models/SourceRoute.html +140 -0
- data/docs/Cdss/Models/Station.html +248 -0
- data/docs/Cdss/Models/Structure.html +259 -0
- data/docs/Cdss/Models/WaterClass.html +249 -0
- data/docs/Cdss/Models/WaterRight.html +255 -0
- data/docs/Cdss/Models/Well.html +251 -0
- data/docs/Cdss/Models.html +117 -0
- data/docs/Cdss/Parser.html +2155 -0
- data/docs/Cdss/Parsers/AdminCallsParser.html +201 -0
- data/docs/Cdss/Parsers/AnalysisParser.html +296 -0
- data/docs/Cdss/Parsers/BaseParser.html +207 -0
- data/docs/Cdss/Parsers/ClimateParser.html +253 -0
- data/docs/Cdss/Parsers/ReadingParser.html +201 -0
- data/docs/Cdss/Parsers/ReferenceTablesParser.html +201 -0
- data/docs/Cdss/Parsers/StationParser.html +201 -0
- data/docs/Cdss/Parsers/StructuresParser.html +305 -0
- data/docs/Cdss/Parsers/WaterRightsParser.html +219 -0
- data/docs/Cdss/Parsers/WellParser.html +357 -0
- data/docs/Cdss/Parsers.html +117 -0
- data/docs/Cdss/ReferenceTables.html +332 -0
- data/docs/Cdss/Structures.html +1132 -0
- data/docs/Cdss/SurfaceWater.html +798 -0
- data/docs/Cdss/Telemetry.html +763 -0
- data/docs/Cdss/Utils.html +1276 -0
- data/docs/Cdss/WaterRights.html +634 -0
- data/docs/Cdss.html +292 -0
- data/docs/_index.html +493 -0
- data/docs/class_list.html +54 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +503 -0
- data/docs/file.README.html +108 -0
- data/docs/file_list.html +59 -0
- data/docs/frames.html +22 -0
- data/docs/index.html +108 -0
- data/docs/js/app.js +344 -0
- data/docs/js/full_list.js +242 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +790 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/cdss/admin_calls.rb +44 -0
- data/lib/cdss/analysis.rb +183 -0
- data/lib/cdss/client.rb +121 -0
- data/lib/cdss/climate.rb +155 -0
- data/lib/cdss/concerns/log_reading_attributes.rb +48 -0
- data/lib/cdss/concerns/well_reading_attributes.rb +56 -0
- data/lib/cdss/ground_water.rb +112 -0
- data/lib/cdss/models/admin_call.rb +45 -0
- data/lib/cdss/models/analysis.rb +77 -0
- data/lib/cdss/models/climate_station.rb +40 -0
- data/lib/cdss/models/reading.rb +54 -0
- data/lib/cdss/models/reference_table.rb +56 -0
- data/lib/cdss/models/station.rb +40 -0
- data/lib/cdss/models/structure.rb +101 -0
- data/lib/cdss/models/water_right.rb +47 -0
- data/lib/cdss/models/well.rb +43 -0
- data/lib/cdss/parser.rb +172 -0
- data/lib/cdss/parsers/admin_calls_parser.rb +47 -0
- data/lib/cdss/parsers/analysis_parser.rb +124 -0
- data/lib/cdss/parsers/base_parser.rb +18 -0
- data/lib/cdss/parsers/climate_parser.rb +86 -0
- data/lib/cdss/parsers/reading_parser.rb +90 -0
- data/lib/cdss/parsers/reference_tables_parser.rb +55 -0
- data/lib/cdss/parsers/station_parser.rb +42 -0
- data/lib/cdss/parsers/structures_parser.rb +96 -0
- data/lib/cdss/parsers/water_rights_parser.rb +77 -0
- data/lib/cdss/parsers/well_parser.rb +107 -0
- data/lib/cdss/reference_tables.rb +147 -0
- data/lib/cdss/structures.rb +235 -0
- data/lib/cdss/surface_water.rb +186 -0
- data/lib/cdss/telemetry.rb +98 -0
- data/lib/cdss/utils.rb +152 -0
- data/lib/cdss/version.rb +5 -0
- data/lib/cdss/water_rights.rb +95 -0
- data/lib/cdss.rb +27 -0
- data/sig/cdss/ruby.rbs +6 -0
- metadata +272 -0
@@ -0,0 +1,763 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
Module: Cdss::Telemetry
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.37
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
16
|
+
|
17
|
+
<script type="text/javascript">
|
18
|
+
pathId = "Cdss::Telemetry";
|
19
|
+
relpath = '../';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="../_index.html">Index (T)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../Cdss.html" title="Cdss (module)">Cdss</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Telemetry</span>
|
43
|
+
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<div id="search">
|
47
|
+
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
49
|
+
href="../class_list.html">
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<div id="content"><h1>Module: Cdss::Telemetry
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
<dl>
|
75
|
+
<dt>Includes:</dt>
|
76
|
+
<dd><span class='object_link'><a href="Utils.html" title="Cdss::Utils (module)">Utils</a></span></dd>
|
77
|
+
</dl>
|
78
|
+
|
79
|
+
|
80
|
+
|
81
|
+
|
82
|
+
<dl>
|
83
|
+
<dt>Included in:</dt>
|
84
|
+
<dd><span class='object_link'><a href="Client.html" title="Cdss::Client (class)">Client</a></span></dd>
|
85
|
+
</dl>
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
<dl>
|
90
|
+
<dt>Defined in:</dt>
|
91
|
+
<dd>lib/cdss/telemetry.rb</dd>
|
92
|
+
</dl>
|
93
|
+
|
94
|
+
</div>
|
95
|
+
|
96
|
+
<h2>Overview</h2><div class="docstring">
|
97
|
+
<div class="discussion">
|
98
|
+
|
99
|
+
<p>Provides methods for accessing telemetry station data from the CDSS API.</p>
|
100
|
+
|
101
|
+
<p>This module includes functionality for retrieving telemetry stations and their associated time series data.</p>
|
102
|
+
|
103
|
+
|
104
|
+
</div>
|
105
|
+
</div>
|
106
|
+
<div class="tags">
|
107
|
+
|
108
|
+
|
109
|
+
</div>
|
110
|
+
|
111
|
+
|
112
|
+
|
113
|
+
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
<h2>
|
118
|
+
Instance Method Summary
|
119
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
120
|
+
</h2>
|
121
|
+
|
122
|
+
<ul class="summary">
|
123
|
+
|
124
|
+
<li class="public ">
|
125
|
+
<span class="summary_signature">
|
126
|
+
|
127
|
+
<a href="#get_telemetry_stations-instance_method" title="#get_telemetry_stations (instance method)">#<strong>get_telemetry_stations</strong>(aoi: nil, radius: nil, abbrev: nil, county: nil, division: nil, gnis_id: nil, usgs_id: nil, water_district: nil, wdid: nil) ⇒ Array<Station> </a>
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
</span>
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
<span class="summary_desc"><div class='inline'>
|
142
|
+
<p>Fetches telemetry stations based on various filtering criteria.</p>
|
143
|
+
</div></span>
|
144
|
+
|
145
|
+
</li>
|
146
|
+
|
147
|
+
|
148
|
+
<li class="public ">
|
149
|
+
<span class="summary_signature">
|
150
|
+
|
151
|
+
<a href="#get_telemetry_ts-instance_method" title="#get_telemetry_ts (instance method)">#<strong>get_telemetry_ts</strong>(abbrev:, parameter: "DISCHRG", start_date: nil, end_date: nil, timescale: "day", include_third_party: true) ⇒ Array<Reading> </a>
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
</span>
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
<span class="summary_desc"><div class='inline'>
|
166
|
+
<p>Fetches telemetry time series data for specified stations.</p>
|
167
|
+
</div></span>
|
168
|
+
|
169
|
+
</li>
|
170
|
+
|
171
|
+
|
172
|
+
</ul>
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Cdss::Utils (module)">Utils</a></span></h3>
|
185
|
+
<p class="inherited"><span class='object_link'><a href="Utils.html#batch_dates-instance_method" title="Cdss::Utils#batch_dates (method)">#batch_dates</a></span>, <span class='object_link'><a href="Utils.html#build_query-instance_method" title="Cdss::Utils#build_query (method)">#build_query</a></span>, <span class='object_link'><a href="Utils.html#fetch_paginated_data-instance_method" title="Cdss::Utils#fetch_paginated_data (method)">#fetch_paginated_data</a></span>, <span class='object_link'><a href="Utils.html#format_date-instance_method" title="Cdss::Utils#format_date (method)">#format_date</a></span>, <span class='object_link'><a href="Utils.html#format_query_param-instance_method" title="Cdss::Utils#format_query_param (method)">#format_query_param</a></span>, <span class='object_link'><a href="Utils.html#parse_timestamp-instance_method" title="Cdss::Utils#parse_timestamp (method)">#parse_timestamp</a></span>, <span class='object_link'><a href="Utils.html#safe_float-instance_method" title="Cdss::Utils#safe_float (method)">#safe_float</a></span>, <span class='object_link'><a href="Utils.html#safe_integer-instance_method" title="Cdss::Utils#safe_integer (method)">#safe_integer</a></span></p>
|
186
|
+
|
187
|
+
|
188
|
+
<div id="instance_method_details" class="method_details_list">
|
189
|
+
<h2>Instance Method Details</h2>
|
190
|
+
|
191
|
+
|
192
|
+
<div class="method_details first">
|
193
|
+
<h3 class="signature first" id="get_telemetry_stations-instance_method">
|
194
|
+
|
195
|
+
#<strong>get_telemetry_stations</strong>(aoi: nil, radius: nil, abbrev: nil, county: nil, division: nil, gnis_id: nil, usgs_id: nil, water_district: nil, wdid: nil) ⇒ <tt>Array<Station></tt>
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
</h3><div class="docstring">
|
202
|
+
<div class="discussion">
|
203
|
+
|
204
|
+
<p>Fetches telemetry stations based on various filtering criteria.</p>
|
205
|
+
|
206
|
+
|
207
|
+
</div>
|
208
|
+
</div>
|
209
|
+
<div class="tags">
|
210
|
+
|
211
|
+
<div class="examples">
|
212
|
+
<h4 class="tag_title">Examples:</h4>
|
213
|
+
|
214
|
+
|
215
|
+
<h5 class="example_title"><div class='inline'>
|
216
|
+
<p>Fetch stations in Denver county</p>
|
217
|
+
</div></h5>
|
218
|
+
|
219
|
+
<pre class="example code"><code><span class='id identifier rubyid_get_telemetry_stations'>get_telemetry_stations</span><span class='lparen'>(</span><span class='label'>county:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Denver</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span></code></pre>
|
220
|
+
|
221
|
+
|
222
|
+
<h5 class="example_title"><div class='inline'>
|
223
|
+
<p>Fetch stations within 10 miles of a point</p>
|
224
|
+
</div></h5>
|
225
|
+
|
226
|
+
<pre class="example code"><code><span class='id identifier rubyid_get_telemetry_stations'>get_telemetry_stations</span><span class='lparen'>(</span><span class='label'>aoi:</span> <span class='lbrace'>{</span> <span class='label'>latitude:</span> <span class='float'>39.7392</span><span class='comma'>,</span> <span class='label'>longitude:</span> <span class='op'>-</span><span class='float'>104.9903</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>radius:</span> <span class='int'>10</span><span class='rparen'>)</span></code></pre>
|
227
|
+
|
228
|
+
</div>
|
229
|
+
<p class="tag_title">Parameters:</p>
|
230
|
+
<ul class="param">
|
231
|
+
|
232
|
+
<li>
|
233
|
+
|
234
|
+
<span class='name'>aoi</span>
|
235
|
+
|
236
|
+
|
237
|
+
<span class='type'>(<tt>Hash</tt>, <tt>Array</tt>, <tt>nil</tt>)</span>
|
238
|
+
|
239
|
+
|
240
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
241
|
+
|
242
|
+
|
243
|
+
—
|
244
|
+
<div class='inline'>
|
245
|
+
<p>Area of interest for spatial searches. If hash, must contain :latitude and :longitude keys. If array, must contain [longitude, latitude].</p>
|
246
|
+
</div>
|
247
|
+
|
248
|
+
</li>
|
249
|
+
|
250
|
+
<li>
|
251
|
+
|
252
|
+
<span class='name'>radius</span>
|
253
|
+
|
254
|
+
|
255
|
+
<span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
|
256
|
+
|
257
|
+
|
258
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
259
|
+
|
260
|
+
|
261
|
+
—
|
262
|
+
<div class='inline'>
|
263
|
+
<p>Radius in miles for spatial search around aoi. Defaults to 20 if aoi is provided.</p>
|
264
|
+
</div>
|
265
|
+
|
266
|
+
</li>
|
267
|
+
|
268
|
+
<li>
|
269
|
+
|
270
|
+
<span class='name'>abbrev</span>
|
271
|
+
|
272
|
+
|
273
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
274
|
+
|
275
|
+
|
276
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
277
|
+
|
278
|
+
|
279
|
+
—
|
280
|
+
<div class='inline'>
|
281
|
+
<p>Station abbreviation to filter by.</p>
|
282
|
+
</div>
|
283
|
+
|
284
|
+
</li>
|
285
|
+
|
286
|
+
<li>
|
287
|
+
|
288
|
+
<span class='name'>county</span>
|
289
|
+
|
290
|
+
|
291
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
292
|
+
|
293
|
+
|
294
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
295
|
+
|
296
|
+
|
297
|
+
—
|
298
|
+
<div class='inline'>
|
299
|
+
<p>County name to filter stations.</p>
|
300
|
+
</div>
|
301
|
+
|
302
|
+
</li>
|
303
|
+
|
304
|
+
<li>
|
305
|
+
|
306
|
+
<span class='name'>division</span>
|
307
|
+
|
308
|
+
|
309
|
+
<span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
|
310
|
+
|
311
|
+
|
312
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
313
|
+
|
314
|
+
|
315
|
+
—
|
316
|
+
<div class='inline'>
|
317
|
+
<p>Water division number to filter stations.</p>
|
318
|
+
</div>
|
319
|
+
|
320
|
+
</li>
|
321
|
+
|
322
|
+
<li>
|
323
|
+
|
324
|
+
<span class='name'>gnis_id</span>
|
325
|
+
|
326
|
+
|
327
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
328
|
+
|
329
|
+
|
330
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
331
|
+
|
332
|
+
|
333
|
+
—
|
334
|
+
<div class='inline'>
|
335
|
+
<p>GNIS ID to filter by.</p>
|
336
|
+
</div>
|
337
|
+
|
338
|
+
</li>
|
339
|
+
|
340
|
+
<li>
|
341
|
+
|
342
|
+
<span class='name'>usgs_id</span>
|
343
|
+
|
344
|
+
|
345
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
346
|
+
|
347
|
+
|
348
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
349
|
+
|
350
|
+
|
351
|
+
—
|
352
|
+
<div class='inline'>
|
353
|
+
<p>USGS station ID to filter by.</p>
|
354
|
+
</div>
|
355
|
+
|
356
|
+
</li>
|
357
|
+
|
358
|
+
<li>
|
359
|
+
|
360
|
+
<span class='name'>water_district</span>
|
361
|
+
|
362
|
+
|
363
|
+
<span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
|
364
|
+
|
365
|
+
|
366
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
367
|
+
|
368
|
+
|
369
|
+
—
|
370
|
+
<div class='inline'>
|
371
|
+
<p>Water district number to filter by.</p>
|
372
|
+
</div>
|
373
|
+
|
374
|
+
</li>
|
375
|
+
|
376
|
+
<li>
|
377
|
+
|
378
|
+
<span class='name'>wdid</span>
|
379
|
+
|
380
|
+
|
381
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
382
|
+
|
383
|
+
|
384
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
385
|
+
|
386
|
+
|
387
|
+
—
|
388
|
+
<div class='inline'>
|
389
|
+
<p>WDID to filter by.</p>
|
390
|
+
</div>
|
391
|
+
|
392
|
+
</li>
|
393
|
+
|
394
|
+
</ul>
|
395
|
+
|
396
|
+
<p class="tag_title">Returns:</p>
|
397
|
+
<ul class="return">
|
398
|
+
|
399
|
+
<li>
|
400
|
+
|
401
|
+
|
402
|
+
<span class='type'>(<tt>Array<Station></tt>)</span>
|
403
|
+
|
404
|
+
|
405
|
+
|
406
|
+
—
|
407
|
+
<div class='inline'>
|
408
|
+
<p>Array of matching telemetry station objects.</p>
|
409
|
+
</div>
|
410
|
+
|
411
|
+
</li>
|
412
|
+
|
413
|
+
</ul>
|
414
|
+
<p class="tag_title">Raises:</p>
|
415
|
+
<ul class="raise">
|
416
|
+
|
417
|
+
<li>
|
418
|
+
|
419
|
+
|
420
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
421
|
+
|
422
|
+
|
423
|
+
|
424
|
+
—
|
425
|
+
<div class='inline'>
|
426
|
+
<p>If aoi parameter is provided but invalid.</p>
|
427
|
+
</div>
|
428
|
+
|
429
|
+
</li>
|
430
|
+
|
431
|
+
</ul>
|
432
|
+
|
433
|
+
</div><table class="source_code">
|
434
|
+
<tr>
|
435
|
+
<td>
|
436
|
+
<pre class="lines">
|
437
|
+
|
438
|
+
|
439
|
+
29
|
440
|
+
30
|
441
|
+
31
|
442
|
+
32
|
443
|
+
33
|
444
|
+
34
|
445
|
+
35
|
446
|
+
36
|
447
|
+
37
|
448
|
+
38
|
449
|
+
39
|
450
|
+
40
|
451
|
+
41
|
452
|
+
42
|
453
|
+
43
|
454
|
+
44
|
455
|
+
45
|
456
|
+
46
|
457
|
+
47
|
458
|
+
48
|
459
|
+
49
|
460
|
+
50
|
461
|
+
51
|
462
|
+
52
|
463
|
+
53
|
464
|
+
54
|
465
|
+
55
|
466
|
+
56
|
467
|
+
57
|
468
|
+
58
|
469
|
+
59
|
470
|
+
60</pre>
|
471
|
+
</td>
|
472
|
+
<td>
|
473
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/telemetry.rb', line 29</span>
|
474
|
+
|
475
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_telemetry_stations'>get_telemetry_stations</span><span class='lparen'>(</span><span class='label'>aoi:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>radius:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>abbrev:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>county:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>division:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>gnis_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
476
|
+
<span class='label'>usgs_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>water_district:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>wdid:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
477
|
+
<span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
478
|
+
<span class='label'>format:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>json</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
479
|
+
<span class='label'>dateFormat:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>spaceSepToSeconds</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
480
|
+
<span class='label'>includeThirdParty:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
481
|
+
<span class='label'>abbrev:</span> <span class='id identifier rubyid_abbrev'>abbrev</span><span class='comma'>,</span>
|
482
|
+
<span class='label'>county:</span> <span class='id identifier rubyid_county'>county</span><span class='comma'>,</span>
|
483
|
+
<span class='label'>division:</span> <span class='id identifier rubyid_division'>division</span><span class='comma'>,</span>
|
484
|
+
<span class='label'>gnisId:</span> <span class='id identifier rubyid_gnis_id'>gnis_id</span><span class='comma'>,</span>
|
485
|
+
<span class='label'>usgsStationId:</span> <span class='id identifier rubyid_usgs_id'>usgs_id</span><span class='comma'>,</span>
|
486
|
+
<span class='label'>waterDistrict:</span> <span class='id identifier rubyid_water_district'>water_district</span><span class='comma'>,</span>
|
487
|
+
<span class='label'>wdid:</span> <span class='id identifier rubyid_wdid'>wdid</span>
|
488
|
+
<span class='rbrace'>}</span>
|
489
|
+
|
490
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_aoi'>aoi</span>
|
491
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_aoi'>aoi</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_aoi'>aoi</span><span class='lbracket'>[</span><span class='symbol'>:latitude</span><span class='rbracket'>]</span> <span class='op'>&&</span> <span class='id identifier rubyid_aoi'>aoi</span><span class='lbracket'>[</span><span class='symbol'>:longitude</span><span class='rbracket'>]</span>
|
492
|
+
<span class='id identifier rubyid_query'>query</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='label'>longitude:</span> <span class='id identifier rubyid_aoi'>aoi</span><span class='lbracket'>[</span><span class='symbol'>:longitude</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>latitude:</span> <span class='id identifier rubyid_aoi'>aoi</span><span class='lbracket'>[</span><span class='symbol'>:latitude</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
493
|
+
<span class='kw'>elsif</span> <span class='id identifier rubyid_aoi'>aoi</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_aoi'>aoi</span><span class='period'>.</span><span class='id identifier rubyid_count'>count</span> <span class='op'>==</span> <span class='int'>2</span>
|
494
|
+
<span class='id identifier rubyid_query'>query</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='label'>longitude:</span> <span class='id identifier rubyid_aoi'>aoi</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>latitude:</span> <span class='id identifier rubyid_aoi'>aoi</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
495
|
+
<span class='kw'>else</span>
|
496
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid 'aoi' parameter</span><span class='tstring_end'>"</span></span>
|
497
|
+
<span class='kw'>end</span>
|
498
|
+
<span class='id identifier rubyid_query'>query</span><span class='lbracket'>[</span><span class='symbol'>:radius</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_radius'>radius</span> <span class='op'>||</span> <span class='int'>20</span>
|
499
|
+
<span class='id identifier rubyid_query'>query</span><span class='lbracket'>[</span><span class='symbol'>:units</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>miles</span><span class='tstring_end'>"</span></span>
|
500
|
+
<span class='kw'>end</span>
|
501
|
+
|
502
|
+
<span class='id identifier rubyid_fetch_paginated_data'>fetch_paginated_data</span><span class='lparen'>(</span>
|
503
|
+
<span class='label'>endpoint:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/telemetrystations/telemetrystation/</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
504
|
+
<span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span>
|
505
|
+
<span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_data'>data</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="Parser.html" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_stations'><span class='object_link'><a href="Parser.html#parse_stations-class_method" title="Cdss::Parser.parse_stations (method)">parse_stations</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
506
|
+
<span class='kw'>end</span></pre>
|
507
|
+
</td>
|
508
|
+
</tr>
|
509
|
+
</table>
|
510
|
+
</div>
|
511
|
+
|
512
|
+
<div class="method_details ">
|
513
|
+
<h3 class="signature " id="get_telemetry_ts-instance_method">
|
514
|
+
|
515
|
+
#<strong>get_telemetry_ts</strong>(abbrev:, parameter: "DISCHRG", start_date: nil, end_date: nil, timescale: "day", include_third_party: true) ⇒ <tt>Array<Reading></tt>
|
516
|
+
|
517
|
+
|
518
|
+
|
519
|
+
|
520
|
+
|
521
|
+
</h3><div class="docstring">
|
522
|
+
<div class="discussion">
|
523
|
+
|
524
|
+
<p>Fetches telemetry time series data for specified stations.</p>
|
525
|
+
|
526
|
+
|
527
|
+
</div>
|
528
|
+
</div>
|
529
|
+
<div class="tags">
|
530
|
+
|
531
|
+
<div class="examples">
|
532
|
+
<h4 class="tag_title">Examples:</h4>
|
533
|
+
|
534
|
+
|
535
|
+
<h5 class="example_title"><div class='inline'>
|
536
|
+
<p>Fetch daily discharge data for a station</p>
|
537
|
+
</div></h5>
|
538
|
+
|
539
|
+
<pre class="example code"><code><span class='id identifier rubyid_get_telemetry_ts'>get_telemetry_ts</span><span class='lparen'>(</span><span class='label'>abbrev:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>PLACHECO</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>parameter:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>DISCHRG</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>start_date:</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='int'>2023</span><span class='comma'>,</span> <span class='int'>1</span><span class='comma'>,</span> <span class='int'>1</span><span class='rparen'>)</span><span class='rparen'>)</span></code></pre>
|
540
|
+
|
541
|
+
</div>
|
542
|
+
<p class="tag_title">Parameters:</p>
|
543
|
+
<ul class="param">
|
544
|
+
|
545
|
+
<li>
|
546
|
+
|
547
|
+
<span class='name'>abbrev</span>
|
548
|
+
|
549
|
+
|
550
|
+
<span class='type'>(<tt>String</tt>)</span>
|
551
|
+
|
552
|
+
|
553
|
+
|
554
|
+
—
|
555
|
+
<div class='inline'>
|
556
|
+
<p>Station abbreviation.</p>
|
557
|
+
</div>
|
558
|
+
|
559
|
+
</li>
|
560
|
+
|
561
|
+
<li>
|
562
|
+
|
563
|
+
<span class='name'>parameter</span>
|
564
|
+
|
565
|
+
|
566
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
567
|
+
|
568
|
+
|
569
|
+
<em class="default">(defaults to: <tt>"DISCHRG"</tt>)</em>
|
570
|
+
|
571
|
+
|
572
|
+
—
|
573
|
+
<div class='inline'>
|
574
|
+
<p>Telemetry parameter to retrieve. Defaults to ‘DISCHRG’.</p>
|
575
|
+
</div>
|
576
|
+
|
577
|
+
</li>
|
578
|
+
|
579
|
+
<li>
|
580
|
+
|
581
|
+
<span class='name'>start_date</span>
|
582
|
+
|
583
|
+
|
584
|
+
<span class='type'>(<tt>Date</tt>, <tt>nil</tt>)</span>
|
585
|
+
|
586
|
+
|
587
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
588
|
+
|
589
|
+
|
590
|
+
—
|
591
|
+
<div class='inline'>
|
592
|
+
<p>Start date for time series data.</p>
|
593
|
+
</div>
|
594
|
+
|
595
|
+
</li>
|
596
|
+
|
597
|
+
<li>
|
598
|
+
|
599
|
+
<span class='name'>end_date</span>
|
600
|
+
|
601
|
+
|
602
|
+
<span class='type'>(<tt>Date</tt>, <tt>nil</tt>)</span>
|
603
|
+
|
604
|
+
|
605
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
606
|
+
|
607
|
+
|
608
|
+
—
|
609
|
+
<div class='inline'>
|
610
|
+
<p>End date for time series data.</p>
|
611
|
+
</div>
|
612
|
+
|
613
|
+
</li>
|
614
|
+
|
615
|
+
<li>
|
616
|
+
|
617
|
+
<span class='name'>timescale</span>
|
618
|
+
|
619
|
+
|
620
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
621
|
+
|
622
|
+
|
623
|
+
<em class="default">(defaults to: <tt>"day"</tt>)</em>
|
624
|
+
|
625
|
+
|
626
|
+
—
|
627
|
+
<div class='inline'>
|
628
|
+
<p>Time interval for data. Valid values: ‘day’, ‘hour’, ‘raw’.</p>
|
629
|
+
</div>
|
630
|
+
|
631
|
+
</li>
|
632
|
+
|
633
|
+
<li>
|
634
|
+
|
635
|
+
<span class='name'>include_third_party</span>
|
636
|
+
|
637
|
+
|
638
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
639
|
+
|
640
|
+
|
641
|
+
<em class="default">(defaults to: <tt>true</tt>)</em>
|
642
|
+
|
643
|
+
|
644
|
+
—
|
645
|
+
<div class='inline'>
|
646
|
+
<p>Whether to include third-party data. Defaults to true.</p>
|
647
|
+
</div>
|
648
|
+
|
649
|
+
</li>
|
650
|
+
|
651
|
+
</ul>
|
652
|
+
|
653
|
+
<p class="tag_title">Returns:</p>
|
654
|
+
<ul class="return">
|
655
|
+
|
656
|
+
<li>
|
657
|
+
|
658
|
+
|
659
|
+
<span class='type'>(<tt>Array<Reading></tt>)</span>
|
660
|
+
|
661
|
+
|
662
|
+
|
663
|
+
—
|
664
|
+
<div class='inline'>
|
665
|
+
<p>Array of time series reading objects.</p>
|
666
|
+
</div>
|
667
|
+
|
668
|
+
</li>
|
669
|
+
|
670
|
+
</ul>
|
671
|
+
<p class="tag_title">Raises:</p>
|
672
|
+
<ul class="raise">
|
673
|
+
|
674
|
+
<li>
|
675
|
+
|
676
|
+
|
677
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
678
|
+
|
679
|
+
|
680
|
+
|
681
|
+
—
|
682
|
+
<div class='inline'>
|
683
|
+
<p>If an invalid timescale is provided.</p>
|
684
|
+
</div>
|
685
|
+
|
686
|
+
</li>
|
687
|
+
|
688
|
+
</ul>
|
689
|
+
|
690
|
+
</div><table class="source_code">
|
691
|
+
<tr>
|
692
|
+
<td>
|
693
|
+
<pre class="lines">
|
694
|
+
|
695
|
+
|
696
|
+
74
|
697
|
+
75
|
698
|
+
76
|
699
|
+
77
|
700
|
+
78
|
701
|
+
79
|
702
|
+
80
|
703
|
+
81
|
704
|
+
82
|
705
|
+
83
|
706
|
+
84
|
707
|
+
85
|
708
|
+
86
|
709
|
+
87
|
710
|
+
88
|
711
|
+
89
|
712
|
+
90
|
713
|
+
91
|
714
|
+
92
|
715
|
+
93
|
716
|
+
94
|
717
|
+
95
|
718
|
+
96</pre>
|
719
|
+
</td>
|
720
|
+
<td>
|
721
|
+
<pre class="code"><span class="info file"># File 'lib/cdss/telemetry.rb', line 74</span>
|
722
|
+
|
723
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_telemetry_ts'>get_telemetry_ts</span><span class='lparen'>(</span><span class='label'>abbrev:</span><span class='comma'>,</span> <span class='label'>parameter:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>DISCHRG</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>start_date:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>end_date:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>timescale:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>day</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
724
|
+
<span class='label'>include_third_party:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
725
|
+
<span class='id identifier rubyid_timescales'>timescales</span> <span class='op'>=</span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>day</span><span class='words_sep'> </span><span class='tstring_content'>hour</span><span class='words_sep'> </span><span class='tstring_content'>raw</span><span class='tstring_end'>]</span></span>
|
726
|
+
<span class='kw'>unless</span> <span class='id identifier rubyid_timescales'>timescales</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_timescale'>timescale</span><span class='rparen'>)</span>
|
727
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid 'timescale' argument: '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_timescale'>timescale</span><span class='embexpr_end'>}</span><span class='tstring_content'>'. Valid values are: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_timescales'>timescales</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>, </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
728
|
+
<span class='kw'>end</span>
|
729
|
+
|
730
|
+
<span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
731
|
+
<span class='label'>format:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>json</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
732
|
+
<span class='label'>dateFormat:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>spaceSepToSeconds</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
733
|
+
<span class='label'>abbrev:</span> <span class='id identifier rubyid_abbrev'>abbrev</span><span class='comma'>,</span>
|
734
|
+
<span class='label'>parameter:</span> <span class='id identifier rubyid_parameter'>parameter</span><span class='comma'>,</span>
|
735
|
+
<span class='label'>includeThirdParty:</span> <span class='id identifier rubyid_include_third_party'>include_third_party</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
736
|
+
<span class='rbrace'>}</span>
|
737
|
+
|
738
|
+
<span class='id identifier rubyid_query'>query</span><span class='lbracket'>[</span><span class='symbol'>:startDate</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_start_date'>start_date</span><span class='op'>&.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%m-%d-%Y</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_start_date'>start_date</span>
|
739
|
+
<span class='id identifier rubyid_query'>query</span><span class='lbracket'>[</span><span class='symbol'>:endDate</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_end_date'>end_date</span><span class='op'>&.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%m-%d-%Y</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_end_date'>end_date</span>
|
740
|
+
|
741
|
+
<span class='id identifier rubyid_fetch_paginated_data'>fetch_paginated_data</span><span class='lparen'>(</span>
|
742
|
+
<span class='label'>endpoint:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/telemetrystations/telemetrytimeseries</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_timescale'>timescale</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
743
|
+
<span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span>
|
744
|
+
<span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_data'>data</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="Parser.html" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_readings'><span class='object_link'><a href="Parser.html#parse_readings-class_method" title="Cdss::Parser.parse_readings (method)">parse_readings</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>timescale:</span> <span class='id identifier rubyid_timescale'>timescale</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
745
|
+
<span class='kw'>end</span></pre>
|
746
|
+
</td>
|
747
|
+
</tr>
|
748
|
+
</table>
|
749
|
+
</div>
|
750
|
+
|
751
|
+
</div>
|
752
|
+
|
753
|
+
</div>
|
754
|
+
|
755
|
+
<div id="footer">
|
756
|
+
Generated on Thu Feb 20 21:19:08 2025 by
|
757
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
758
|
+
0.9.37 (ruby-3.2.2).
|
759
|
+
</div>
|
760
|
+
|
761
|
+
</div>
|
762
|
+
</body>
|
763
|
+
</html>
|