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.
Files changed (99) hide show
  1. checksums.yaml +7 -0
  2. data/.rubocop.yml +86 -0
  3. data/CHANGELOG.md +5 -0
  4. data/CODE_OF_CONDUCT.md +84 -0
  5. data/README.md +101 -0
  6. data/Rakefile +26 -0
  7. data/docs/Cdss/AdminCalls.html +399 -0
  8. data/docs/Cdss/Analysis.html +972 -0
  9. data/docs/Cdss/Client.html +581 -0
  10. data/docs/Cdss/Climate.html +1257 -0
  11. data/docs/Cdss/Concerns/LogReadingAttributes.html +406 -0
  12. data/docs/Cdss/Concerns/WellReadingAttributes.html +414 -0
  13. data/docs/Cdss/Concerns.html +117 -0
  14. data/docs/Cdss/GroundWater.html +945 -0
  15. data/docs/Cdss/Models/AdminCall.html +252 -0
  16. data/docs/Cdss/Models/Analysis.html +397 -0
  17. data/docs/Cdss/Models/CallAnalysis.html +140 -0
  18. data/docs/Cdss/Models/ClimateStation.html +249 -0
  19. data/docs/Cdss/Models/DiversionRecord.html +248 -0
  20. data/docs/Cdss/Models/Reading.html +301 -0
  21. data/docs/Cdss/Models/ReferenceTable.html +339 -0
  22. data/docs/Cdss/Models/RouteAnalysis.html +140 -0
  23. data/docs/Cdss/Models/SourceRoute.html +140 -0
  24. data/docs/Cdss/Models/Station.html +248 -0
  25. data/docs/Cdss/Models/Structure.html +259 -0
  26. data/docs/Cdss/Models/WaterClass.html +249 -0
  27. data/docs/Cdss/Models/WaterRight.html +255 -0
  28. data/docs/Cdss/Models/Well.html +251 -0
  29. data/docs/Cdss/Models.html +117 -0
  30. data/docs/Cdss/Parser.html +2155 -0
  31. data/docs/Cdss/Parsers/AdminCallsParser.html +201 -0
  32. data/docs/Cdss/Parsers/AnalysisParser.html +296 -0
  33. data/docs/Cdss/Parsers/BaseParser.html +207 -0
  34. data/docs/Cdss/Parsers/ClimateParser.html +253 -0
  35. data/docs/Cdss/Parsers/ReadingParser.html +201 -0
  36. data/docs/Cdss/Parsers/ReferenceTablesParser.html +201 -0
  37. data/docs/Cdss/Parsers/StationParser.html +201 -0
  38. data/docs/Cdss/Parsers/StructuresParser.html +305 -0
  39. data/docs/Cdss/Parsers/WaterRightsParser.html +219 -0
  40. data/docs/Cdss/Parsers/WellParser.html +357 -0
  41. data/docs/Cdss/Parsers.html +117 -0
  42. data/docs/Cdss/ReferenceTables.html +332 -0
  43. data/docs/Cdss/Structures.html +1132 -0
  44. data/docs/Cdss/SurfaceWater.html +798 -0
  45. data/docs/Cdss/Telemetry.html +763 -0
  46. data/docs/Cdss/Utils.html +1276 -0
  47. data/docs/Cdss/WaterRights.html +634 -0
  48. data/docs/Cdss.html +292 -0
  49. data/docs/_index.html +493 -0
  50. data/docs/class_list.html +54 -0
  51. data/docs/css/common.css +1 -0
  52. data/docs/css/full_list.css +58 -0
  53. data/docs/css/style.css +503 -0
  54. data/docs/file.README.html +108 -0
  55. data/docs/file_list.html +59 -0
  56. data/docs/frames.html +22 -0
  57. data/docs/index.html +108 -0
  58. data/docs/js/app.js +344 -0
  59. data/docs/js/full_list.js +242 -0
  60. data/docs/js/jquery.js +4 -0
  61. data/docs/method_list.html +790 -0
  62. data/docs/top-level-namespace.html +110 -0
  63. data/lib/cdss/admin_calls.rb +44 -0
  64. data/lib/cdss/analysis.rb +183 -0
  65. data/lib/cdss/client.rb +121 -0
  66. data/lib/cdss/climate.rb +155 -0
  67. data/lib/cdss/concerns/log_reading_attributes.rb +48 -0
  68. data/lib/cdss/concerns/well_reading_attributes.rb +56 -0
  69. data/lib/cdss/ground_water.rb +112 -0
  70. data/lib/cdss/models/admin_call.rb +45 -0
  71. data/lib/cdss/models/analysis.rb +77 -0
  72. data/lib/cdss/models/climate_station.rb +40 -0
  73. data/lib/cdss/models/reading.rb +54 -0
  74. data/lib/cdss/models/reference_table.rb +56 -0
  75. data/lib/cdss/models/station.rb +40 -0
  76. data/lib/cdss/models/structure.rb +101 -0
  77. data/lib/cdss/models/water_right.rb +47 -0
  78. data/lib/cdss/models/well.rb +43 -0
  79. data/lib/cdss/parser.rb +172 -0
  80. data/lib/cdss/parsers/admin_calls_parser.rb +47 -0
  81. data/lib/cdss/parsers/analysis_parser.rb +124 -0
  82. data/lib/cdss/parsers/base_parser.rb +18 -0
  83. data/lib/cdss/parsers/climate_parser.rb +86 -0
  84. data/lib/cdss/parsers/reading_parser.rb +90 -0
  85. data/lib/cdss/parsers/reference_tables_parser.rb +55 -0
  86. data/lib/cdss/parsers/station_parser.rb +42 -0
  87. data/lib/cdss/parsers/structures_parser.rb +96 -0
  88. data/lib/cdss/parsers/water_rights_parser.rb +77 -0
  89. data/lib/cdss/parsers/well_parser.rb +107 -0
  90. data/lib/cdss/reference_tables.rb +147 -0
  91. data/lib/cdss/structures.rb +235 -0
  92. data/lib/cdss/surface_water.rb +186 -0
  93. data/lib/cdss/telemetry.rb +98 -0
  94. data/lib/cdss/utils.rb +152 -0
  95. data/lib/cdss/version.rb +5 -0
  96. data/lib/cdss/water_rights.rb +95 -0
  97. data/lib/cdss.rb +27 -0
  98. data/sig/cdss/ruby.rbs +6 -0
  99. metadata +272 -0
data/docs/Cdss/GroundWater.html ADDED
@@ -0,0 +1,945 @@
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::GroundWater
8
+
9
+ &mdash; 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::GroundWater";
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 (G)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Cdss.html" title="Cdss (module)">Cdss</a></span></span>
41
+ &raquo;
42
+ <span class="title">GroundWater</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::GroundWater
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/ground_water.rb</dd>
92
+ </dl>
93
+
94
+ </div>
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+ <h2>
105
+ Instance Method Summary
106
+ <small><a href="#" class="summary_toggle">collapse</a></small>
107
+ </h2>
108
+
109
+ <ul class="summary">
110
+
111
+ <li class="public ">
112
+ <span class="summary_signature">
113
+
114
+ <a href="#get_geophysical_log_picks-instance_method" title="#get_geophysical_log_picks (instance method)">#<strong>get_geophysical_log_picks</strong>(wellid:) &#x21d2; Array&lt;LogPick&gt; </a>
115
+
116
+
117
+
118
+ </span>
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+ <span class="summary_desc"><div class='inline'>
129
+ <p>Fetches geophysical log picks for a specific well.</p>
130
+ </div></span>
131
+
132
+ </li>
133
+
134
+
135
+ <li class="public ">
136
+ <span class="summary_signature">
137
+
138
+ <a href="#get_geophysical_log_wells-instance_method" title="#get_geophysical_log_wells (instance method)">#<strong>get_geophysical_log_wells</strong>(county: nil, designated_basin: nil, division: nil, management_district: nil, water_district: nil, wellid: nil) &#x21d2; Array&lt;Well&gt; </a>
139
+
140
+
141
+
142
+ </span>
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+ <span class="summary_desc"><div class='inline'>
153
+ <p>Fetches groundwater geophysical log wells based on filters.</p>
154
+ </div></span>
155
+
156
+ </li>
157
+
158
+
159
+ <li class="public ">
160
+ <span class="summary_signature">
161
+
162
+ <a href="#get_water_level_wells-instance_method" title="#get_water_level_wells (instance method)">#<strong>get_water_level_wells</strong>(county: nil, designated_basin: nil, division: nil, management_district: nil, water_district: nil, wellid: nil) &#x21d2; Array&lt;Well&gt; </a>
163
+
164
+
165
+
166
+ </span>
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+ <span class="summary_desc"><div class='inline'>
177
+ <p>Fetches groundwater water level wells based on filters.</p>
178
+ </div></span>
179
+
180
+ </li>
181
+
182
+
183
+ <li class="public ">
184
+ <span class="summary_signature">
185
+
186
+ <a href="#get_well_measurements-instance_method" title="#get_well_measurements (instance method)">#<strong>get_well_measurements</strong>(wellid:, start_date: nil, end_date: nil) &#x21d2; Array&lt;Reading&gt; </a>
187
+
188
+
189
+
190
+ </span>
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+ <span class="summary_desc"><div class='inline'>
201
+ <p>Fetches water level measurements for a specific well.</p>
202
+ </div></span>
203
+
204
+ </li>
205
+
206
+
207
+ </ul>
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Cdss::Utils (module)">Utils</a></span></h3>
220
+ <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>
221
+
222
+
223
+ <div id="instance_method_details" class="method_details_list">
224
+ <h2>Instance Method Details</h2>
225
+
226
+
227
+ <div class="method_details first">
228
+ <h3 class="signature first" id="get_geophysical_log_picks-instance_method">
229
+
230
+ #<strong>get_geophysical_log_picks</strong>(wellid:) &#x21d2; <tt>Array&lt;LogPick&gt;</tt>
231
+
232
+
233
+
234
+
235
+
236
+ </h3><div class="docstring">
237
+ <div class="discussion">
238
+
239
+ <p>Fetches geophysical log picks for a specific well</p>
240
+
241
+
242
+ </div>
243
+ </div>
244
+ <div class="tags">
245
+
246
+ <div class="examples">
247
+ <h4 class="tag_title">Examples:</h4>
248
+
249
+
250
+ <h5 class="example_title"><div class='inline'>
251
+ <p>Fetch log picks for a specific well</p>
252
+ </div></h5>
253
+
254
+ <pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get_geophysical_log_picks'>get_geophysical_log_picks</span><span class='lparen'>(</span><span class='label'>wellid:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1234</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
255
+
256
+ </div>
257
+ <p class="tag_title">Parameters:</p>
258
+ <ul class="param">
259
+
260
+ <li>
261
+
262
+ <span class='name'>wellid</span>
263
+
264
+
265
+ <span class='type'>(<tt>String</tt>)</span>
266
+
267
+
268
+
269
+ &mdash;
270
+ <div class='inline'>
271
+ <p>Well ID to fetch log picks for</p>
272
+ </div>
273
+
274
+ </li>
275
+
276
+ </ul>
277
+
278
+ <p class="tag_title">Returns:</p>
279
+ <ul class="return">
280
+
281
+ <li>
282
+
283
+
284
+ <span class='type'>(<tt>Array&lt;LogPick&gt;</tt>)</span>
285
+
286
+
287
+
288
+ &mdash;
289
+ <div class='inline'>
290
+ <p>An array of geophysical log pick objects</p>
291
+ </div>
292
+
293
+ </li>
294
+
295
+ </ul>
296
+ <p class="tag_title">Raises:</p>
297
+ <ul class="raise">
298
+
299
+ <li>
300
+
301
+
302
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
303
+
304
+
305
+
306
+ &mdash;
307
+ <div class='inline'>
308
+ <p>if wellid is nil</p>
309
+ </div>
310
+
311
+ </li>
312
+
313
+ </ul>
314
+
315
+ </div><table class="source_code">
316
+ <tr>
317
+ <td>
318
+ <pre class="lines">
319
+
320
+
321
+ 97
322
+ 98
323
+ 99
324
+ 100
325
+ 101
326
+ 102
327
+ 103
328
+ 104
329
+ 105
330
+ 106
331
+ 107
332
+ 108
333
+ 109
334
+ 110</pre>
335
+ </td>
336
+ <td>
337
+ <pre class="code"><span class="info file"># File 'lib/cdss/ground_water.rb', line 97</span>
338
+
339
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_geophysical_log_picks'>get_geophysical_log_picks</span><span class='lparen'>(</span><span class='label'>wellid:</span><span class='rparen'>)</span>
340
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>wellid is required</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_wellid'>wellid</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
341
+
342
+ <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span>
343
+ <span class='label'>format:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>json</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
344
+ <span class='label'>dateFormat:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>spaceSepToSeconds</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
345
+ <span class='label'>wellId:</span> <span class='id identifier rubyid_wellid'>wellid</span>
346
+ <span class='rbrace'>}</span>
347
+
348
+ <span class='id identifier rubyid_fetch_paginated_data'>fetch_paginated_data</span><span class='lparen'>(</span>
349
+ <span class='label'>endpoint:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/groundwater/geophysicallogs/geoplogpicks/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
350
+ <span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span>
351
+ <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_log_picks'><span class='object_link'><a href="Parser.html#parse_log_picks-class_method" title="Cdss::Parser.parse_log_picks (method)">parse_log_picks</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
352
+ <span class='kw'>end</span></pre>
353
+ </td>
354
+ </tr>
355
+ </table>
356
+ </div>
357
+
358
+ <div class="method_details ">
359
+ <h3 class="signature " id="get_geophysical_log_wells-instance_method">
360
+
361
+ #<strong>get_geophysical_log_wells</strong>(county: nil, designated_basin: nil, division: nil, management_district: nil, water_district: nil, wellid: nil) &#x21d2; <tt>Array&lt;Well&gt;</tt>
362
+
363
+
364
+
365
+
366
+
367
+ </h3><div class="docstring">
368
+ <div class="discussion">
369
+
370
+ <p>Fetches groundwater geophysical log wells based on filters</p>
371
+
372
+
373
+ </div>
374
+ </div>
375
+ <div class="tags">
376
+
377
+ <div class="examples">
378
+ <h4 class="tag_title">Examples:</h4>
379
+
380
+
381
+ <h5 class="example_title"><div class='inline'>
382
+ <p>Fetch geophysical log wells in Denver county</p>
383
+ </div></h5>
384
+
385
+ <pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get_geophysical_log_wells'>get_geophysical_log_wells</span><span class='lparen'>(</span><span class='label'>county:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Denver</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
386
+
387
+ </div>
388
+ <p class="tag_title">Parameters:</p>
389
+ <ul class="param">
390
+
391
+ <li>
392
+
393
+ <span class='name'>county</span>
394
+
395
+
396
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
397
+
398
+
399
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
400
+
401
+
402
+ &mdash;
403
+ <div class='inline'>
404
+ <p>County to filter wells</p>
405
+ </div>
406
+
407
+ </li>
408
+
409
+ <li>
410
+
411
+ <span class='name'>designated_basin</span>
412
+
413
+
414
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
415
+
416
+
417
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
418
+
419
+
420
+ &mdash;
421
+ <div class='inline'>
422
+ <p>Designated basin to filter wells</p>
423
+ </div>
424
+
425
+ </li>
426
+
427
+ <li>
428
+
429
+ <span class='name'>division</span>
430
+
431
+
432
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
433
+
434
+
435
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
436
+
437
+
438
+ &mdash;
439
+ <div class='inline'>
440
+ <p>Division to filter wells</p>
441
+ </div>
442
+
443
+ </li>
444
+
445
+ <li>
446
+
447
+ <span class='name'>management_district</span>
448
+
449
+
450
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
451
+
452
+
453
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
454
+
455
+
456
+ &mdash;
457
+ <div class='inline'>
458
+ <p>Management district to filter wells</p>
459
+ </div>
460
+
461
+ </li>
462
+
463
+ <li>
464
+
465
+ <span class='name'>water_district</span>
466
+
467
+
468
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
469
+
470
+
471
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
472
+
473
+
474
+ &mdash;
475
+ <div class='inline'>
476
+ <p>Water district number to filter wells</p>
477
+ </div>
478
+
479
+ </li>
480
+
481
+ <li>
482
+
483
+ <span class='name'>wellid</span>
484
+
485
+
486
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
487
+
488
+
489
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
490
+
491
+
492
+ &mdash;
493
+ <div class='inline'>
494
+ <p>Well ID to filter specific well</p>
495
+ </div>
496
+
497
+ </li>
498
+
499
+ </ul>
500
+
501
+ <p class="tag_title">Returns:</p>
502
+ <ul class="return">
503
+
504
+ <li>
505
+
506
+
507
+ <span class='type'>(<tt>Array&lt;Well&gt;</tt>)</span>
508
+
509
+
510
+
511
+ &mdash;
512
+ <div class='inline'>
513
+ <p>An array of geophysical log well objects</p>
514
+ </div>
515
+
516
+ </li>
517
+
518
+ </ul>
519
+
520
+ </div><table class="source_code">
521
+ <tr>
522
+ <td>
523
+ <pre class="lines">
524
+
525
+
526
+ 71
527
+ 72
528
+ 73
529
+ 74
530
+ 75
531
+ 76
532
+ 77
533
+ 78
534
+ 79
535
+ 80
536
+ 81
537
+ 82
538
+ 83
539
+ 84
540
+ 85
541
+ 86
542
+ 87
543
+ 88</pre>
544
+ </td>
545
+ <td>
546
+ <pre class="code"><span class="info file"># File 'lib/cdss/ground_water.rb', line 71</span>
547
+
548
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_geophysical_log_wells'>get_geophysical_log_wells</span><span class='lparen'>(</span><span class='label'>county:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>designated_basin:</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'>management_district:</span> <span class='kw'>nil</span><span class='comma'>,</span>
549
+ <span class='label'>water_district:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>wellid:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
550
+ <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span>
551
+ <span class='label'>format:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>json</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
552
+ <span class='label'>dateFormat:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>spaceSepToSeconds</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
553
+ <span class='label'>county:</span> <span class='id identifier rubyid_county'>county</span><span class='op'>&amp;.</span><span class='id identifier rubyid_upcase'>upcase</span><span class='op'>&amp;.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>+</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
554
+ <span class='label'>designatedBasin:</span> <span class='id identifier rubyid_designated_basin'>designated_basin</span><span class='op'>&amp;.</span><span class='id identifier rubyid_upcase'>upcase</span><span class='op'>&amp;.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>+</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
555
+ <span class='label'>division:</span> <span class='id identifier rubyid_division'>division</span><span class='comma'>,</span>
556
+ <span class='label'>managementDistrict:</span> <span class='id identifier rubyid_management_district'>management_district</span><span class='op'>&amp;.</span><span class='id identifier rubyid_upcase'>upcase</span><span class='op'>&amp;.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>+</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
557
+ <span class='label'>waterDistrict:</span> <span class='id identifier rubyid_water_district'>water_district</span><span class='comma'>,</span>
558
+ <span class='label'>wellId:</span> <span class='id identifier rubyid_wellid'>wellid</span>
559
+ <span class='rbrace'>}</span>
560
+
561
+ <span class='id identifier rubyid_fetch_paginated_data'>fetch_paginated_data</span><span class='lparen'>(</span>
562
+ <span class='label'>endpoint:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/groundwater/geophysicallogs/wells/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
563
+ <span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span>
564
+ <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_geophysical_wells'><span class='object_link'><a href="Parser.html#parse_geophysical_wells-class_method" title="Cdss::Parser.parse_geophysical_wells (method)">parse_geophysical_wells</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
565
+ <span class='kw'>end</span></pre>
566
+ </td>
567
+ </tr>
568
+ </table>
569
+ </div>
570
+
571
+ <div class="method_details ">
572
+ <h3 class="signature " id="get_water_level_wells-instance_method">
573
+
574
+ #<strong>get_water_level_wells</strong>(county: nil, designated_basin: nil, division: nil, management_district: nil, water_district: nil, wellid: nil) &#x21d2; <tt>Array&lt;Well&gt;</tt>
575
+
576
+
577
+
578
+
579
+
580
+ </h3><div class="docstring">
581
+ <div class="discussion">
582
+
583
+ <p>Fetches groundwater water level wells based on filters.</p>
584
+
585
+
586
+ </div>
587
+ </div>
588
+ <div class="tags">
589
+
590
+ <div class="examples">
591
+ <h4 class="tag_title">Examples:</h4>
592
+
593
+
594
+ <h5 class="example_title"><div class='inline'>
595
+ <p>Fetch wells in Denver county</p>
596
+ </div></h5>
597
+
598
+ <pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get_water_level_wells'>get_water_level_wells</span><span class='lparen'>(</span><span class='label'>county:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Denver</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></code></pre>
599
+
600
+ </div>
601
+ <p class="tag_title">Parameters:</p>
602
+ <ul class="param">
603
+
604
+ <li>
605
+
606
+ <span class='name'>county</span>
607
+
608
+
609
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
610
+
611
+
612
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
613
+
614
+
615
+ &mdash;
616
+ <div class='inline'>
617
+ <p>County to filter wells</p>
618
+ </div>
619
+
620
+ </li>
621
+
622
+ <li>
623
+
624
+ <span class='name'>designated_basin</span>
625
+
626
+
627
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
628
+
629
+
630
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
631
+
632
+
633
+ &mdash;
634
+ <div class='inline'>
635
+ <p>Designated basin to filter wells</p>
636
+ </div>
637
+
638
+ </li>
639
+
640
+ <li>
641
+
642
+ <span class='name'>division</span>
643
+
644
+
645
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
646
+
647
+
648
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
649
+
650
+
651
+ &mdash;
652
+ <div class='inline'>
653
+ <p>Division to filter wells</p>
654
+ </div>
655
+
656
+ </li>
657
+
658
+ <li>
659
+
660
+ <span class='name'>management_district</span>
661
+
662
+
663
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
664
+
665
+
666
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
667
+
668
+
669
+ &mdash;
670
+ <div class='inline'>
671
+ <p>Management district to filter wells</p>
672
+ </div>
673
+
674
+ </li>
675
+
676
+ <li>
677
+
678
+ <span class='name'>water_district</span>
679
+
680
+
681
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
682
+
683
+
684
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
685
+
686
+
687
+ &mdash;
688
+ <div class='inline'>
689
+ <p>Water district number to filter wells</p>
690
+ </div>
691
+
692
+ </li>
693
+
694
+ <li>
695
+
696
+ <span class='name'>wellid</span>
697
+
698
+
699
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
700
+
701
+
702
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
703
+
704
+
705
+ &mdash;
706
+ <div class='inline'>
707
+ <p>Well ID to filter specific well</p>
708
+ </div>
709
+
710
+ </li>
711
+
712
+ </ul>
713
+
714
+ <p class="tag_title">Returns:</p>
715
+ <ul class="return">
716
+
717
+ <li>
718
+
719
+
720
+ <span class='type'>(<tt>Array&lt;Well&gt;</tt>)</span>
721
+
722
+
723
+
724
+ &mdash;
725
+ <div class='inline'>
726
+ <p>An array of groundwater well objects</p>
727
+ </div>
728
+
729
+ </li>
730
+
731
+ </ul>
732
+
733
+ </div><table class="source_code">
734
+ <tr>
735
+ <td>
736
+ <pre class="lines">
737
+
738
+
739
+ 18
740
+ 19
741
+ 20
742
+ 21
743
+ 22
744
+ 23
745
+ 24
746
+ 25
747
+ 26
748
+ 27
749
+ 28
750
+ 29
751
+ 30
752
+ 31
753
+ 32
754
+ 33
755
+ 34
756
+ 35</pre>
757
+ </td>
758
+ <td>
759
+ <pre class="code"><span class="info file"># File 'lib/cdss/ground_water.rb', line 18</span>
760
+
761
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_water_level_wells'>get_water_level_wells</span><span class='lparen'>(</span><span class='label'>county:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>designated_basin:</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'>management_district:</span> <span class='kw'>nil</span><span class='comma'>,</span>
762
+ <span class='label'>water_district:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>wellid:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
763
+ <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span>
764
+ <span class='label'>format:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>json</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
765
+ <span class='label'>dateFormat:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>spaceSepToSeconds</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
766
+ <span class='label'>county:</span> <span class='id identifier rubyid_county'>county</span><span class='op'>&amp;.</span><span class='id identifier rubyid_upcase'>upcase</span><span class='op'>&amp;.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>+</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
767
+ <span class='label'>designatedBasin:</span> <span class='id identifier rubyid_designated_basin'>designated_basin</span><span class='op'>&amp;.</span><span class='id identifier rubyid_upcase'>upcase</span><span class='op'>&amp;.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>+</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
768
+ <span class='label'>division:</span> <span class='id identifier rubyid_division'>division</span><span class='comma'>,</span>
769
+ <span class='label'>managementDistrict:</span> <span class='id identifier rubyid_management_district'>management_district</span><span class='op'>&amp;.</span><span class='id identifier rubyid_upcase'>upcase</span><span class='op'>&amp;.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>+</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
770
+ <span class='label'>waterDistrict:</span> <span class='id identifier rubyid_water_district'>water_district</span><span class='comma'>,</span>
771
+ <span class='label'>wellId:</span> <span class='id identifier rubyid_wellid'>wellid</span>
772
+ <span class='rbrace'>}</span>
773
+
774
+ <span class='id identifier rubyid_fetch_paginated_data'>fetch_paginated_data</span><span class='lparen'>(</span>
775
+ <span class='label'>endpoint:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/groundwater/waterlevels/wells/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
776
+ <span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span>
777
+ <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_wells'><span class='object_link'><a href="Parser.html#parse_wells-class_method" title="Cdss::Parser.parse_wells (method)">parse_wells</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
778
+ <span class='kw'>end</span></pre>
779
+ </td>
780
+ </tr>
781
+ </table>
782
+ </div>
783
+
784
+ <div class="method_details ">
785
+ <h3 class="signature " id="get_well_measurements-instance_method">
786
+
787
+ #<strong>get_well_measurements</strong>(wellid:, start_date: nil, end_date: nil) &#x21d2; <tt>Array&lt;Reading&gt;</tt>
788
+
789
+
790
+
791
+
792
+
793
+ </h3><div class="docstring">
794
+ <div class="discussion">
795
+
796
+ <p>Fetches water level measurements for a specific well</p>
797
+
798
+
799
+ </div>
800
+ </div>
801
+ <div class="tags">
802
+
803
+ <div class="examples">
804
+ <h4 class="tag_title">Examples:</h4>
805
+
806
+
807
+ <h5 class="example_title"><div class='inline'>
808
+ <p>Fetch measurements for a specific well</p>
809
+ </div></h5>
810
+
811
+ <pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get_well_measurements'>get_well_measurements</span><span class='lparen'>(</span><span class='label'>wellid:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1234</span><span class='tstring_end'>&#39;</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_parse'>parse</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>2021-01-01</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span></code></pre>
812
+
813
+ </div>
814
+ <p class="tag_title">Parameters:</p>
815
+ <ul class="param">
816
+
817
+ <li>
818
+
819
+ <span class='name'>wellid</span>
820
+
821
+
822
+ <span class='type'>(<tt>String</tt>)</span>
823
+
824
+
825
+
826
+ &mdash;
827
+ <div class='inline'>
828
+ <p>Well ID to fetch measurements for</p>
829
+ </div>
830
+
831
+ </li>
832
+
833
+ <li>
834
+
835
+ <span class='name'>start_date</span>
836
+
837
+
838
+ <span class='type'>(<tt>Date</tt>, <tt>nil</tt>)</span>
839
+
840
+
841
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
842
+
843
+
844
+ &mdash;
845
+ <div class='inline'>
846
+ <p>Start date for the data range</p>
847
+ </div>
848
+
849
+ </li>
850
+
851
+ <li>
852
+
853
+ <span class='name'>end_date</span>
854
+
855
+
856
+ <span class='type'>(<tt>Date</tt>, <tt>nil</tt>)</span>
857
+
858
+
859
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
860
+
861
+
862
+ &mdash;
863
+ <div class='inline'>
864
+ <p>End date for the data range</p>
865
+ </div>
866
+
867
+ </li>
868
+
869
+ </ul>
870
+
871
+ <p class="tag_title">Returns:</p>
872
+ <ul class="return">
873
+
874
+ <li>
875
+
876
+
877
+ <span class='type'>(<tt>Array&lt;Reading&gt;</tt>)</span>
878
+
879
+
880
+
881
+ &mdash;
882
+ <div class='inline'>
883
+ <p>An array of water level measurements</p>
884
+ </div>
885
+
886
+ </li>
887
+
888
+ </ul>
889
+
890
+ </div><table class="source_code">
891
+ <tr>
892
+ <td>
893
+ <pre class="lines">
894
+
895
+
896
+ 45
897
+ 46
898
+ 47
899
+ 48
900
+ 49
901
+ 50
902
+ 51
903
+ 52
904
+ 53
905
+ 54
906
+ 55
907
+ 56
908
+ 57
909
+ 58</pre>
910
+ </td>
911
+ <td>
912
+ <pre class="code"><span class="info file"># File 'lib/cdss/ground_water.rb', line 45</span>
913
+
914
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_well_measurements'>get_well_measurements</span><span class='lparen'>(</span><span class='label'>wellid:</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='rparen'>)</span>
915
+ <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span>
916
+ <span class='label'>format:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>json</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
917
+ <span class='label'>dateFormat:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>spaceSepToSeconds</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
918
+ <span class='label'>wellId:</span> <span class='id identifier rubyid_wellid'>wellid</span><span class='comma'>,</span>
919
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>min-measurementDate</span><span class='label_end'>&quot;:</span> <span class='id identifier rubyid_start_date'>start_date</span><span class='op'>&amp;.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>%m-%d-%Y</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
920
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>max-measurementDate</span><span class='label_end'>&quot;:</span> <span class='id identifier rubyid_end_date'>end_date</span><span class='op'>&amp;.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>%m-%d-%Y</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
921
+ <span class='rbrace'>}</span>
922
+
923
+ <span class='id identifier rubyid_fetch_paginated_data'>fetch_paginated_data</span><span class='lparen'>(</span>
924
+ <span class='label'>endpoint:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/groundwater/waterlevels/wellmeasurements/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
925
+ <span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span>
926
+ <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_well_measurements'><span class='object_link'><a href="Parser.html#parse_well_measurements-class_method" title="Cdss::Parser.parse_well_measurements (method)">parse_well_measurements</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
927
+ <span class='kw'>end</span></pre>
928
+ </td>
929
+ </tr>
930
+ </table>
931
+ </div>
932
+
933
+ </div>
934
+
935
+ </div>
936
+
937
+ <div id="footer">
938
+ Generated on Thu Feb 20 21:19:08 2025 by
939
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
940
+ 0.9.37 (ruby-3.2.2).
941
+ </div>
942
+
943
+ </div>
944
+ </body>
945
+ </html>