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/Concerns/WellReadingAttributes.html ADDED
@@ -0,0 +1,414 @@
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::Concerns::WellReadingAttributes
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::Concerns::WellReadingAttributes";
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 (W)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../Cdss.html" title="Cdss (module)">Cdss</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Concerns.html" title="Cdss::Concerns (module)">Concerns</a></span></span>
41
+ &raquo;
42
+ <span class="title">WellReadingAttributes</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::Concerns::WellReadingAttributes
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <dl>
78
+ <dt>Included in:</dt>
79
+ <dd><span class='object_link'><a href="../Models/Reading.html" title="Cdss::Models::Reading (class)">Models::Reading</a></span></dd>
80
+ </dl>
81
+
82
+
83
+
84
+ <dl>
85
+ <dt>Defined in:</dt>
86
+ <dd>lib/cdss/concerns/well_reading_attributes.rb</dd>
87
+ </dl>
88
+
89
+ </div>
90
+
91
+ <h2>Overview</h2><div class="docstring">
92
+ <div class="discussion">
93
+
94
+ <p>A concern module that adds well reading-related attributes to classes.</p>
95
+
96
+ <p>This module provides a comprehensive set of standardized attributes for well reading data, including identification, location, measurement, and publication information. When included in a class, it dynamically adds accessor methods for these attributes.</p>
97
+
98
+
99
+ </div>
100
+ </div>
101
+ <div class="tags">
102
+
103
+ <div class="examples">
104
+ <h4 class="tag_title">Examples:</h4>
105
+
106
+
107
+ <h5 class="example_title"><div class='inline'>
108
+ <p>Adding well reading attributes to a class</p>
109
+ </div></h5>
110
+
111
+ <pre class="example code"><code><span class='kw'>class</span> <span class='const'>WellReading</span>
112
+ <span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../../Cdss.html" title="Cdss (module)">Cdss</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Concerns.html" title="Cdss::Concerns (module)">Concerns</a></span></span><span class='op'>::</span><span class='const'>WellReadingAttributes</span>
113
+ <span class='kw'>end</span></code></pre>
114
+
115
+ </div>
116
+
117
+
118
+ </div>
119
+
120
+ <h2>
121
+ Constant Summary
122
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
123
+ </h2>
124
+
125
+ <dl class="constants">
126
+
127
+ <dt id="WELL_ATTRIBUTES-constant" class="">WELL_ATTRIBUTES =
128
+ <div class="docstring">
129
+ <div class="discussion">
130
+
131
+ <p>Predefined list of well reading attributes</p>
132
+
133
+
134
+ </div>
135
+ </div>
136
+ <div class="tags">
137
+
138
+ <p class="tag_title">Returns:</p>
139
+ <ul class="return">
140
+
141
+ <li>
142
+
143
+
144
+ <span class='type'>(<tt>Array&lt;Symbol&gt;</tt>)</span>
145
+
146
+
147
+
148
+ &mdash;
149
+ <div class='inline'>
150
+ <p>List of attributes related to well readings</p>
151
+ </div>
152
+
153
+ </li>
154
+
155
+ </ul>
156
+
157
+ </div>
158
+ </dt>
159
+ <dd><pre class="code"><span class='qsymbols_beg'>%i[</span><span class='words_sep'>
160
+ </span><span class='tstring_content'>well_id</span><span class='words_sep'>
161
+ </span><span class='tstring_content'>well_name</span><span class='words_sep'>
162
+ </span><span class='tstring_content'>division</span><span class='words_sep'>
163
+ </span><span class='tstring_content'>water_district</span><span class='words_sep'>
164
+ </span><span class='tstring_content'>county</span><span class='words_sep'>
165
+ </span><span class='tstring_content'>management_district</span><span class='words_sep'>
166
+ </span><span class='tstring_content'>designated_basin</span><span class='words_sep'>
167
+ </span><span class='tstring_content'>publication</span><span class='words_sep'>
168
+ </span><span class='tstring_content'>depth_to_water</span><span class='words_sep'>
169
+ </span><span class='tstring_content'>measuring_point_above_land_surface</span><span class='words_sep'>
170
+ </span><span class='tstring_content'>measurement_date</span><span class='words_sep'>
171
+ </span><span class='tstring_content'>depth_water_below_land_surface</span><span class='words_sep'>
172
+ </span><span class='tstring_content'>elevation_of_water</span><span class='words_sep'>
173
+ </span><span class='tstring_content'>delta</span><span class='words_sep'>
174
+ </span><span class='tstring_content'>published</span><span class='words_sep'>
175
+ </span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
176
+
177
+ </dl>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+ <h2>
188
+ Class Method Summary
189
+ <small><a href="#" class="summary_toggle">collapse</a></small>
190
+ </h2>
191
+
192
+ <ul class="summary">
193
+
194
+ <li class="public ">
195
+ <span class="summary_signature">
196
+
197
+ <a href="#included-class_method" title="included (class method)">.<strong>included</strong>(base) &#x21d2; Object </a>
198
+
199
+
200
+
201
+ </span>
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+ <span class="summary_desc"><div class='inline'>
212
+ <p>Dynamically adds accessor methods when the module is included in a class.</p>
213
+ </div></span>
214
+
215
+ </li>
216
+
217
+
218
+ </ul>
219
+
220
+ <h2>
221
+ Instance Method Summary
222
+ <small><a href="#" class="summary_toggle">collapse</a></small>
223
+ </h2>
224
+
225
+ <ul class="summary">
226
+
227
+ <li class="public ">
228
+ <span class="summary_signature">
229
+
230
+ <a href="#well_reading%3F-instance_method" title="#well_reading? (instance method)">#<strong>well_reading?</strong> &#x21d2; Boolean </a>
231
+
232
+
233
+
234
+ </span>
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+ <span class="summary_desc"><div class='inline'>
245
+ <p>Checks if the instance has a valid well reading.</p>
246
+ </div></span>
247
+
248
+ </li>
249
+
250
+
251
+ </ul>
252
+
253
+
254
+
255
+
256
+ <div id="class_method_details" class="method_details_list">
257
+ <h2>Class Method Details</h2>
258
+
259
+
260
+ <div class="method_details first">
261
+ <h3 class="signature first" id="included-class_method">
262
+
263
+ .<strong>included</strong>(base) &#x21d2; <tt>Object</tt>
264
+
265
+
266
+
267
+
268
+
269
+ </h3><div class="docstring">
270
+ <div class="discussion">
271
+
272
+ <p>Dynamically adds accessor methods when the module is included in a class</p>
273
+
274
+
275
+ </div>
276
+ </div>
277
+ <div class="tags">
278
+ <p class="tag_title">Parameters:</p>
279
+ <ul class="param">
280
+
281
+ <li>
282
+
283
+ <span class='name'>base</span>
284
+
285
+
286
+ <span class='type'>(<tt>Class</tt>)</span>
287
+
288
+
289
+
290
+ &mdash;
291
+ <div class='inline'>
292
+ <p>The class including this module</p>
293
+ </div>
294
+
295
+ </li>
296
+
297
+ </ul>
298
+
299
+
300
+ </div><table class="source_code">
301
+ <tr>
302
+ <td>
303
+ <pre class="lines">
304
+
305
+
306
+ 40
307
+ 41
308
+ 42
309
+ 43
310
+ 44</pre>
311
+ </td>
312
+ <td>
313
+ <pre class="code"><span class="info file"># File 'lib/cdss/concerns/well_reading_attributes.rb', line 40</span>
314
+
315
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
316
+ <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_class_eval'>class_eval</span> <span class='kw'>do</span>
317
+ <span class='id identifier rubyid_attr_accessor'>attr_accessor</span><span class='lparen'>(</span><span class='op'>*</span><span class='const'><span class='object_link'><a href="#WELL_ATTRIBUTES-constant" title="Cdss::Concerns::WellReadingAttributes::WELL_ATTRIBUTES (constant)">WELL_ATTRIBUTES</a></span></span><span class='rparen'>)</span>
318
+ <span class='kw'>end</span>
319
+ <span class='kw'>end</span></pre>
320
+ </td>
321
+ </tr>
322
+ </table>
323
+ </div>
324
+
325
+ </div>
326
+
327
+ <div id="instance_method_details" class="method_details_list">
328
+ <h2>Instance Method Details</h2>
329
+
330
+
331
+ <div class="method_details first">
332
+ <h3 class="signature first" id="well_reading?-instance_method">
333
+
334
+ #<strong>well_reading?</strong> &#x21d2; <tt>Boolean</tt>
335
+
336
+
337
+
338
+
339
+
340
+ </h3><div class="docstring">
341
+ <div class="discussion">
342
+
343
+ <p>Checks if the instance has a valid well reading</p>
344
+
345
+
346
+ </div>
347
+ </div>
348
+ <div class="tags">
349
+
350
+ <div class="examples">
351
+ <h4 class="tag_title">Examples:</h4>
352
+
353
+
354
+ <h5 class="example_title"><div class='inline'>
355
+ <p>Check if a well reading is valid</p>
356
+ </div></h5>
357
+
358
+ <pre class="example code"><code><span class='id identifier rubyid_well_reading'>well_reading</span><span class='period'>.</span><span class='id identifier rubyid_well_reading?'>well_reading?</span> <span class='comment'># =&gt; true or false</span></code></pre>
359
+
360
+ </div>
361
+
362
+ <p class="tag_title">Returns:</p>
363
+ <ul class="return">
364
+
365
+ <li>
366
+
367
+
368
+ <span class='type'>(<tt>Boolean</tt>)</span>
369
+
370
+
371
+
372
+ &mdash;
373
+ <div class='inline'>
374
+ <p>true if a well ID is present, false otherwise</p>
375
+ </div>
376
+
377
+ </li>
378
+
379
+ </ul>
380
+
381
+ </div><table class="source_code">
382
+ <tr>
383
+ <td>
384
+ <pre class="lines">
385
+
386
+
387
+ 51
388
+ 52
389
+ 53</pre>
390
+ </td>
391
+ <td>
392
+ <pre class="code"><span class="info file"># File 'lib/cdss/concerns/well_reading_attributes.rb', line 51</span>
393
+
394
+ <span class='kw'>def</span> <span class='id identifier rubyid_well_reading?'>well_reading?</span>
395
+ <span class='op'>!</span><span class='id identifier rubyid_well_id'>well_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
396
+ <span class='kw'>end</span></pre>
397
+ </td>
398
+ </tr>
399
+ </table>
400
+ </div>
401
+
402
+ </div>
403
+
404
+ </div>
405
+
406
+ <div id="footer">
407
+ Generated on Thu Feb 20 21:19:08 2025 by
408
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
409
+ 0.9.37 (ruby-3.2.2).
410
+ </div>
411
+
412
+ </div>
413
+ </body>
414
+ </html>
data/docs/Cdss/Concerns.html ADDED
@@ -0,0 +1,117 @@
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::Concerns
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::Concerns";
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 (C)</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">Concerns</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::Concerns
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+ <dl>
80
+ <dt>Defined in:</dt>
81
+ <dd>lib/cdss/concerns/log_reading_attributes.rb<span class="defines">,<br />
82
+ lib/cdss/concerns/well_reading_attributes.rb</span>
83
+ </dd>
84
+ </dl>
85
+
86
+ </div>
87
+
88
+ <h2>Defined Under Namespace</h2>
89
+ <p class="children">
90
+
91
+
92
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="Concerns/LogReadingAttributes.html" title="Cdss::Concerns::LogReadingAttributes (module)">LogReadingAttributes</a></span>, <span class='object_link'><a href="Concerns/WellReadingAttributes.html" title="Cdss::Concerns::WellReadingAttributes (module)">WellReadingAttributes</a></span>
93
+
94
+
95
+
96
+
97
+ </p>
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+ </div>
108
+
109
+ <div id="footer">
110
+ Generated on Thu Feb 20 21:19:08 2025 by
111
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
112
+ 0.9.37 (ruby-3.2.2).
113
+ </div>
114
+
115
+ </div>
116
+ </body>
117
+ </html>