@welldot/core 0.1.1 → 0.2.3
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.
- package/LICENSE +76 -53
- package/README.md +142 -48
- package/dist/index.cjs +878 -30
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +4948 -107
- package/dist/index.d.ts +4948 -107
- package/dist/index.js +836 -29
- package/dist/index.js.map +1 -1
- package/docs/profiles/.gitkeep +0 -0
- package/docs/reference/fgdc-textures.md +380 -0
- package/docs/schema/v1/.gitkeep +0 -0
- package/docs/schema/v2/profiles/.gitkeep +0 -0
- package/docs/schema/v2/well.schema.json +954 -0
- package/{well-specifications.md → docs/spec/v1/well-format.md} +160 -95
- package/docs/spec/v2/format-reference.md +534 -0
- package/docs/spec/v2/interoperability.md +177 -0
- package/docs/spec/v2/object-schemas.md +657 -0
- package/docs/spec/v2/overview.md +85 -0
- package/package.json +7 -3
package/LICENSE
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
|
|
1
2
|
Apache License
|
|
2
3
|
Version 2.0, January 2004
|
|
3
4
|
http://www.apache.org/licenses/
|
|
@@ -32,9 +33,10 @@
|
|
|
32
33
|
not limited to compiled object code, generated documentation,
|
|
33
34
|
and conversions to other media types.
|
|
34
35
|
|
|
35
|
-
"Work" shall mean the work of authorship
|
|
36
|
-
the License, as indicated by a
|
|
37
|
-
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
38
40
|
|
|
39
41
|
"Derivative Works" shall mean any work, whether in Source or Object
|
|
40
42
|
form, that is based on (or derived from) the Work and for which the
|
|
@@ -44,21 +46,23 @@
|
|
|
44
46
|
separable from, or merely link (or bind by name) to the interfaces of,
|
|
45
47
|
the Work and Derivative Works thereof.
|
|
46
48
|
|
|
47
|
-
"Contribution" shall mean
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
or
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
62
66
|
|
|
63
67
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
64
68
|
this License, each Contributor hereby grants to You a perpetual,
|
|
@@ -74,22 +78,22 @@
|
|
|
74
78
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
75
79
|
where such license applies only to those patent claims licensable
|
|
76
80
|
by such Contributor that are necessarily infringed by their
|
|
77
|
-
Contribution(s) alone or by
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
78
82
|
with the Work to which such Contribution(s) was submitted. If You
|
|
79
|
-
institute patent litigation against any entity (including a
|
|
80
|
-
or counterclaim in a lawsuit) alleging that the Work
|
|
81
|
-
Contribution
|
|
82
|
-
patent infringement, then any patent licenses
|
|
83
|
-
this License for that Work shall terminate
|
|
84
|
-
litigation is filed.
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
85
89
|
|
|
86
90
|
4. Redistribution. You may reproduce and distribute copies of the
|
|
87
91
|
Work or Derivative Works thereof in any medium, with or without
|
|
88
92
|
modifications, and in Source or Object form, provided that You
|
|
89
93
|
meet the following conditions:
|
|
90
94
|
|
|
91
|
-
(a) You must give any other recipients of the Work or
|
|
92
|
-
Works a copy of this License; and
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
93
97
|
|
|
94
98
|
(b) You must cause any modified files to carry prominent notices
|
|
95
99
|
stating that You changed the files; and
|
|
@@ -101,24 +105,28 @@
|
|
|
101
105
|
the Derivative Works; and
|
|
102
106
|
|
|
103
107
|
(d) If the Work includes a "NOTICE" text file as part of its
|
|
104
|
-
distribution,
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
the
|
|
109
|
-
Derivative Works;
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
122
130
|
|
|
123
131
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
124
132
|
any Contribution intentionally submitted for inclusion in the Work
|
|
@@ -140,7 +148,7 @@
|
|
|
140
148
|
implied, including, without limitation, any warranties or conditions
|
|
141
149
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
142
150
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
143
|
-
appropriateness of using or
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
144
152
|
risks associated with Your exercise of permissions under this License.
|
|
145
153
|
|
|
146
154
|
8. Limitation of Liability. In no event and under no legal theory,
|
|
@@ -148,23 +156,38 @@
|
|
|
148
156
|
unless required by applicable law (such as deliberate and grossly
|
|
149
157
|
negligent acts) or agreed to in writing, shall any Contributor be
|
|
150
158
|
liable to You for damages, including any direct, indirect, special,
|
|
151
|
-
incidental, or
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
152
160
|
result of this License or out of the use or inability to use the
|
|
153
161
|
Work (including but not limited to damages for loss of goodwill,
|
|
154
|
-
work stoppage, computer failure or malfunction, or all
|
|
155
|
-
commercial damages or losses), even if such Contributor
|
|
156
|
-
advised of the possibility of such damages.
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
157
165
|
|
|
158
166
|
9. Accepting Warranty or Additional Liability. While redistributing
|
|
159
167
|
the Work or Derivative Works thereof, You may choose to offer,
|
|
160
168
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
161
169
|
or other liability obligations and/or rights consistent with this
|
|
162
|
-
License. However, in accepting such obligations, You may
|
|
163
|
-
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
164
176
|
|
|
165
177
|
END OF TERMS AND CONDITIONS
|
|
166
178
|
|
|
167
|
-
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2024 Rafael Neto
|
|
168
191
|
|
|
169
192
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
170
193
|
you may not use this file except in compliance with the License.
|
package/README.md
CHANGED
|
@@ -8,15 +8,18 @@ TypeScript types, Zod validators, and serialization utilities for the `.well` op
|
|
|
8
8
|
|
|
9
9
|
## What is `.well`?
|
|
10
10
|
|
|
11
|
-
`.well` is an open file format for encoding the complete
|
|
11
|
+
`.well` is an open file format for encoding the complete record of a water well as a single, self-describing JSON document. A `.well` file contains:
|
|
12
12
|
|
|
13
13
|
- **Constructive data** — borehole geometry, casing strings, screens, reducers, gravel packs, and cement pads
|
|
14
14
|
- **Geologic data** — lithological column, discrete fractures, and cave zones
|
|
15
|
-
- **Administrative metadata** —
|
|
15
|
+
- **Administrative metadata** — well identity, authority-scoped IDs (`well_id`), driller, construction date, and geographic coordinates with explicit CRS
|
|
16
|
+
- **Hydrodynamic events** — append-only ledger of static level readings, pumping tests (constant-rate, step-drawdown, airlift), and recovery phases
|
|
17
|
+
- **Aquifer analysis** — interpreted parameter sets: transmissivity, specific capacity, storativity, and Jacob loss coefficients
|
|
18
|
+
- **Operational history** — timestamped log of maintenance, inspections, and incidents with HTTPS attachment references
|
|
16
19
|
|
|
17
20
|
The format is designed for three use cases: visualization of technical well profiles, registration with regulatory bodies, and hydrogeological research.
|
|
18
21
|
|
|
19
|
-
See the [
|
|
22
|
+
See the [v2 format specification](./docs/spec/v2/overview.md) for the complete schema reference and design rationale. The [v1 spec](./docs/spec/v1/well-format.md) remains available for reference.
|
|
20
23
|
|
|
21
24
|
## Installation
|
|
22
25
|
|
|
@@ -67,43 +70,79 @@ const empty = isWellEmpty(well);
|
|
|
67
70
|
|
|
68
71
|
All types are exported as TypeScript type-only exports (zero runtime cost).
|
|
69
72
|
|
|
70
|
-
| Type
|
|
71
|
-
|
|
72
|
-
| `Well`
|
|
73
|
-
| `BoreHole`
|
|
74
|
-
| `WellCase`
|
|
75
|
-
| `Reduction`
|
|
76
|
-
| `WellScreen`
|
|
77
|
-
| `SurfaceCase`
|
|
78
|
-
| `HoleFill`
|
|
79
|
-
| `CementPad`
|
|
80
|
-
| `Lithology`
|
|
81
|
-
| `
|
|
82
|
-
| `
|
|
83
|
-
| `
|
|
84
|
-
| `
|
|
85
|
-
| `
|
|
86
|
-
| `
|
|
87
|
-
| `
|
|
88
|
-
| `
|
|
73
|
+
| Type | Description |
|
|
74
|
+
| ----------------------- | ------------------------------------------------------------------------------- |
|
|
75
|
+
| `Well` | Complete static record of a water well (v2) |
|
|
76
|
+
| `BoreHole` | A drilled interval with diameter and optional drilling method |
|
|
77
|
+
| `WellCase` | Steel or plastic casing installed in the borehole |
|
|
78
|
+
| `Reduction` | Transition piece between different casing diameters |
|
|
79
|
+
| `WellScreen` | Slotted screen section for water intake (`screen_slot` in mm) |
|
|
80
|
+
| `SurfaceCase` | Protective casing near the surface |
|
|
81
|
+
| `HoleFill` | Annular fill material (`gravel_pack` or `seal`) |
|
|
82
|
+
| `CementPad` | Concrete wellhead pad dimensions |
|
|
83
|
+
| `Lithology` | Geological description of a depth interval |
|
|
84
|
+
| `Texture` | `{ code: string \| number; vocabulary?: string }` — lithology texture reference |
|
|
85
|
+
| `Fracture` | A discrete fracture or fracture zone |
|
|
86
|
+
| `Cave` | A cavity or void zone |
|
|
87
|
+
| `Constructive` | Grouped type: borehole + casings + screens + fills |
|
|
88
|
+
| `Geologic` | Grouped type: lithology + fractures + caves |
|
|
89
|
+
| `WellId` | Authority-scoped well identifier `{ authority, id, primary? }` |
|
|
90
|
+
| `Location` | Geographic location with optional elevation and CRS properties |
|
|
91
|
+
| `LocationProperties` | CRS, datum, and precision metadata for a `Location` |
|
|
92
|
+
| `LevelReading` | A single depth/time reading during a pumping or recovery phase |
|
|
93
|
+
| `RecoveryPhase` | Time-series of level readings after pump shutdown |
|
|
94
|
+
| `PumpingStep` | One flow-rate step in a pumping test |
|
|
95
|
+
| `HydrodynamicEventBase` | Common fields shared by all hydrodynamic event types |
|
|
96
|
+
| `SpotMeasurementEvent` | A single static water level reading |
|
|
97
|
+
| `ConstantRateEvent` | A constant-rate pumping test |
|
|
98
|
+
| `StepDrawdownEvent` | A step-drawdown pumping test |
|
|
99
|
+
| `AirliftEvent` | An air-lift development or test |
|
|
100
|
+
| `RecoveryOnlyEvent` | Recovery measurements without drawdown data |
|
|
101
|
+
| `HydrodynamicEvent` | Discriminated union of all event types + x- custom events |
|
|
102
|
+
| `AquiferAnalysis` | An interpreted set of aquifer parameters |
|
|
103
|
+
| `Attachment` | An HTTPS-referenced file attached to a history log entry |
|
|
104
|
+
| `HistoryLogEntry` | One entry in the operational history log |
|
|
105
|
+
| `Units` | `{ length: 'm' \| 'ft'; diameter: 'mm' \| 'inches' }` |
|
|
106
|
+
| `LengthUnits` | `'m' \| 'ft'` |
|
|
107
|
+
| `DiameterUnits` | `'mm' \| 'inches'` |
|
|
108
|
+
| `UnitsTypes` | `'metric' \| 'imperial'` |
|
|
109
|
+
| `TextureType` | `{ code: TextureCode; label: string }` — a single FGDC texture entry (lookup) |
|
|
110
|
+
| `TextureCode` | `number \| string` — numeric FGDC code or custom string code |
|
|
89
111
|
|
|
90
112
|
### Validators
|
|
91
113
|
|
|
92
114
|
Each schema validates its corresponding type at runtime. All schemas are Zod objects and compose with standard Zod methods (`.parse`, `.safeParse`, `.extend`, etc.).
|
|
93
115
|
|
|
94
|
-
| Export
|
|
95
|
-
|
|
96
|
-
| `WellSchema`
|
|
97
|
-
| `BoreHoleSchema`
|
|
98
|
-
| `WellCaseSchema`
|
|
99
|
-
| `ReductionSchema`
|
|
100
|
-
| `WellScreenSchema`
|
|
101
|
-
| `SurfaceCaseSchema`
|
|
102
|
-
| `HoleFillSchema`
|
|
103
|
-
| `CementPadSchema`
|
|
104
|
-
| `LithologySchema`
|
|
105
|
-
| `
|
|
106
|
-
| `
|
|
116
|
+
| Export | Validates |
|
|
117
|
+
| ----------------------------- | ----------------------------------------------------------------------- |
|
|
118
|
+
| `WellSchema` | `Well` (the complete document; `.passthrough()` preserves unknown keys) |
|
|
119
|
+
| `BoreHoleSchema` | `BoreHole` |
|
|
120
|
+
| `WellCaseSchema` | `WellCase` |
|
|
121
|
+
| `ReductionSchema` | `Reduction` |
|
|
122
|
+
| `WellScreenSchema` | `WellScreen` |
|
|
123
|
+
| `SurfaceCaseSchema` | `SurfaceCase` |
|
|
124
|
+
| `HoleFillSchema` | `HoleFill` |
|
|
125
|
+
| `CementPadSchema` | `CementPad` |
|
|
126
|
+
| `LithologySchema` | `Lithology` |
|
|
127
|
+
| `TextureSchema` | `Texture` |
|
|
128
|
+
| `FractureSchema` | `Fracture` |
|
|
129
|
+
| `CaveSchema` | `Cave` |
|
|
130
|
+
| `WellIdSchema` | `WellId` |
|
|
131
|
+
| `LocationPropertiesSchema` | `LocationProperties` |
|
|
132
|
+
| `LocationSchema` | `Location` |
|
|
133
|
+
| `LevelReadingSchema` | `LevelReading` |
|
|
134
|
+
| `RecoveryPhaseSchema` | `RecoveryPhase` |
|
|
135
|
+
| `PumpingStepSchema` | `PumpingStep` |
|
|
136
|
+
| `HydrodynamicEventBaseSchema` | `HydrodynamicEventBase` |
|
|
137
|
+
| `SpotMeasurementEventSchema` | `SpotMeasurementEvent` |
|
|
138
|
+
| `ConstantRateEventSchema` | `ConstantRateEvent` |
|
|
139
|
+
| `StepDrawdownEventSchema` | `StepDrawdownEvent` |
|
|
140
|
+
| `AirliftEventSchema` | `AirliftEvent` |
|
|
141
|
+
| `RecoveryOnlyEventSchema` | `RecoveryOnlyEvent` |
|
|
142
|
+
| `HydrodynamicEventSchema` | `HydrodynamicEvent` (discriminated union + x- passthrough) |
|
|
143
|
+
| `AquiferAnalysisSchema` | `AquiferAnalysis` |
|
|
144
|
+
| `AttachmentSchema` | `Attachment` |
|
|
145
|
+
| `HistoryLogEntrySchema` | `HistoryLogEntry` |
|
|
107
146
|
|
|
108
147
|
### Functions
|
|
109
148
|
|
|
@@ -113,51 +152,106 @@ Parses a raw JSON string and validates it against `WellSchema`. Throws a `ZodErr
|
|
|
113
152
|
|
|
114
153
|
#### `serializeWell(well: Well): string`
|
|
115
154
|
|
|
116
|
-
Serializes a `Well` object to a versioned `.well` JSON string (`"version":
|
|
155
|
+
Serializes a `Well` object to a versioned `.well` JSON string (`"version": 2`). Emits `location` when set; does not emit deprecated flat `lat`/`lng`/`elevation`. Omits `undefined` optional fields.
|
|
117
156
|
|
|
118
157
|
#### `deserializeWell(jsonString: string): Well | null`
|
|
119
158
|
|
|
120
159
|
Parses and normalizes a JSON string into a `Well`. Handles multiple formats:
|
|
121
160
|
|
|
122
|
-
-
|
|
161
|
+
- v2 format (`"version": 2`) — passes v2-specific fields through directly
|
|
162
|
+
- v1 format (`"version": 1`) — applies v1→v2 normalizations: `fgdc_texture` → `texture`, `screen_slot_mm` → `screen_slot`, flat `lat/lng/elevation` → `location`
|
|
123
163
|
- Legacy formats with `constructive` / `geologic` sub-objects
|
|
124
164
|
- Legacy `diam_pol` inch diameters → `diameter` mm conversion (`× 25.4`)
|
|
125
165
|
- Typo `bole_hole` → `bore_hole` compatibility
|
|
126
166
|
|
|
127
|
-
Returns `null` if the parsed data is empty.
|
|
167
|
+
Returns `null` if the parsed data is empty. Throws on unrecognized version numbers.
|
|
128
168
|
|
|
129
169
|
#### `isWellEmpty(well: Well | null | undefined): boolean`
|
|
130
170
|
|
|
131
171
|
Returns `true` when all constructive and geologic arrays are empty. Accepts `null` and `undefined` (both treated as empty).
|
|
132
172
|
|
|
173
|
+
## FGDC Texture Patterns
|
|
174
|
+
|
|
175
|
+
`FGDC_TEXTURES_OPTIONS` is a typed array of 284 texture pattern entries drawn from the **FGDC Digital Cartographic Standard for Geologic Map Symbolization (FGDC-STD-013-2006)**. Assign a `code` to the `texture` field of a `Lithology` record to attach a standardized fill pattern to a depth interval.
|
|
176
|
+
|
|
177
|
+
```typescript
|
|
178
|
+
import { FGDC_TEXTURES_OPTIONS } from '@welldot/core';
|
|
179
|
+
import type { Texture, TextureCode } from '@welldot/core';
|
|
180
|
+
|
|
181
|
+
// Lookup by code
|
|
182
|
+
const sandstone = FGDC_TEXTURES_OPTIONS.find(t => t.code === 607);
|
|
183
|
+
// { code: 607, label: 'Massive sand or sandstone' }
|
|
184
|
+
|
|
185
|
+
// Build a select list for a UI
|
|
186
|
+
const options = FGDC_TEXTURES_OPTIONS.map(t => ({
|
|
187
|
+
value: t.code,
|
|
188
|
+
label: t.label,
|
|
189
|
+
}));
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
Codes are grouped by series:
|
|
193
|
+
|
|
194
|
+
| Series | Category |
|
|
195
|
+
| ------ | ------------------------------------------------------ |
|
|
196
|
+
| 100 | Surficial deposits |
|
|
197
|
+
| 200 | Sedimentary patterns |
|
|
198
|
+
| 300 | Igneous patterns |
|
|
199
|
+
| 400 | Miscellaneous / Metamorphic patterns |
|
|
200
|
+
| 500 | Glacial / Periglacial patterns |
|
|
201
|
+
| 600 | Sedimentary lithology _(most useful for well logging)_ |
|
|
202
|
+
| 700 | Metamorphic and igneous lithology |
|
|
203
|
+
|
|
204
|
+
See [fgdc-textures.md](./docs/reference/fgdc-textures.md) for the complete annotated list of all 284 codes.
|
|
205
|
+
|
|
133
206
|
## `.well` Format Overview
|
|
134
207
|
|
|
135
208
|
All depths are in **meters** from ground level (0 = surface). All diameters are in **millimeters**. Geographic coordinates use WGS84 decimal degrees. The MIME type is `application/vnd.well+json`.
|
|
136
209
|
|
|
137
|
-
A minimal `.well` document:
|
|
210
|
+
A minimal v2 `.well` document:
|
|
138
211
|
|
|
139
212
|
```json
|
|
140
213
|
{
|
|
141
|
-
"version":
|
|
214
|
+
"version": 2,
|
|
142
215
|
"well_type": "tubular",
|
|
143
216
|
"name": "PP-01",
|
|
144
|
-
"lat": -1.4558,
|
|
145
|
-
"
|
|
146
|
-
|
|
147
|
-
|
|
217
|
+
"location": { "lat": -1.4558, "lng": -48.5039, "elevation": 12.5 },
|
|
218
|
+
"bore_hole": [
|
|
219
|
+
{ "from": 0, "to": 80, "diameter": 250, "drilling_method": "rotary" }
|
|
220
|
+
],
|
|
148
221
|
"well_case": [{ "from": 0, "to": 60, "type": "steel", "diameter": 200 }],
|
|
149
222
|
"reduction": [],
|
|
150
|
-
"well_screen": [
|
|
223
|
+
"well_screen": [
|
|
224
|
+
{
|
|
225
|
+
"from": 60,
|
|
226
|
+
"to": 80,
|
|
227
|
+
"type": "wire_wound",
|
|
228
|
+
"diameter": 150,
|
|
229
|
+
"screen_slot": 0.5
|
|
230
|
+
}
|
|
231
|
+
],
|
|
151
232
|
"surface_case": [{ "from": 0, "to": 3, "diameter": 300 }],
|
|
152
|
-
"hole_fill": [
|
|
153
|
-
|
|
233
|
+
"hole_fill": [
|
|
234
|
+
{
|
|
235
|
+
"from": 60,
|
|
236
|
+
"to": 80,
|
|
237
|
+
"type": "gravel_pack",
|
|
238
|
+
"diameter": 250,
|
|
239
|
+
"description": "2-4mm gravel"
|
|
240
|
+
}
|
|
241
|
+
],
|
|
242
|
+
"cement_pad": {
|
|
243
|
+
"type": "square",
|
|
244
|
+
"width": 1.0,
|
|
245
|
+
"thickness": 0.15,
|
|
246
|
+
"length": 1.0
|
|
247
|
+
},
|
|
154
248
|
"lithology": [],
|
|
155
249
|
"fractures": [],
|
|
156
250
|
"caves": []
|
|
157
251
|
}
|
|
158
252
|
```
|
|
159
253
|
|
|
160
|
-
For the complete schema reference, field vocabulary, design rationale
|
|
254
|
+
For the complete schema reference, field vocabulary, and design rationale see the [`.well` v2 format specification](./docs/spec/v2/overview.md). The [v1 spec](./docs/spec/v1/well-format.md) remains available for reference.
|
|
161
255
|
|
|
162
256
|
## Contributing
|
|
163
257
|
|