Example wells
The format ships with 19 complete example files. Each one is valid and each shows a different situation: rock types, construction styles, test records, operation records, permits, water quality and the messy records real archives contain. Use them to learn the format, to test software and as starting points for your own files.
They are built on real wells from SIAGAS, the groundwater registry of the Geological Survey of Brazil: region, geology, construction and the order of magnitude of test values come from the registry. Names, identifiers, permits, analyses and readings are invented but consistent. Every file says so in an x-welldot-example block.
Get the files
- Download:
https://welldot.org/examples/<file>.well(the links below). - From npm:
@welldot/core/examples/<file>.well, installed with@welldot/core. - On GitHub:
packages/core/examples, with a README on how they were made. - In the editor: welldot.org offers them when you start a new well.
Three to start with
A crystalline supply well with a long history: telescoping hole, screens alternating with casing, centralizers, a 24 h test with its analysis, three permits, meters and production.
A karst well in the Bambuí limestone, with three caves and a solution fracture.
A hand-dug well (cacimba), 10 m deep and 1.2 m wide, with brick lining.
All examples
| Example | Place | Depth | What it shows | Id |
|---|---|---|---|---|
| Public supply in a crystalline aquifer | Coluna/MG | 204 m | Granite under thick saprolite, Nold screens, 24 h test, permits, meters and production. | coluna-mg-cristalino-abastecimento |
| Industrial karst well, decommissioned | Sete Lagoas/MG | 218 m | Bambuí limestone with a cavity, old test record, 1989 analysis, plugged in 2021. | sete-lagoas-mg-carste-industrial |
| Irecê karst: caves and nitrate | Irecê/BA | 60 m | Bambuí limestone with caves, 85 m³/h/m specific capacity, very hard water and nitrate above the limit in 2023. | irece-ba-carste-bambui |
| Public supply in the Lagoa Santa karst | Lagoa Santa/MG | 78 m | 100 m³/h with 3 m of drawdown, 24 h test, telemetry and a permit renewed with a lower rate inside the protected area. | lagoa-santa-mg-carste-abastecimento |
| Incomplete record | Minas Novas/MG | 210 m | Macaúbas schist; construction and lithology only, no test or analysis. | minas-novas-mg-cadastro-incompleto |
| Brackish water in semi-arid crystalline rock | Quixeramobim/CE | 60 m | Fractured biotite schist, 3.5 g/L TDS, community desalinator and salinity during the 2012–2017 drought. | quixeramobim-ce-cristalino-salobro |
| Rural gneiss well: from insignificant use to a permit | Colatina/ES | 80 m | One producing fracture at 67 m, insignificant-use certificate, irrigation permit with a meter and yearly reports. | colatina-es-gnaisse-rural |
| 1561 m stratigraphic well (Guarani) | Rinópolis/SP | 1561 m | Bauru, 1092 m of basalt and confined Guarani; flowing, alkaline thermal water. | rinopolis-sp-estratigrafico-guarani |
| Telescoping well, Bauru + Serra Geral | Estrela d'Oeste/SP | 201 m | Five hole diameters, five screens, mixed intake and rising nitrate. | estrela-doeste-sp-bauru-serra-geral |
| Inconsistent data | Gastão Vidigal/SP | 207 m | Casing from 0.7 m, duplicated grout and an implausible test, kept on purpose. | gastao-vidigal-sp-dados-inconsistentes |
| Deep urban supply well (Barreiras/Pirabas) | Belém/PA | 265 m | 14"→8" reduction, stainless screens, step test, permit, telemetry and 25 layers. | belem-pa-pirabas-abastecimento |
| Licensed condominium well (CNARH + permit) | Belém/PA | 60 m | Current regulatory flow: CNARH, permit with conditions, meter and monthly readings. | belem-pa-condominio-outorga |
| Water quality: acidic water and censored results | Icoaraci, Belém/PA | 60 m | pH below 5, values below the detection limit, duplicate, blank and bacterial contamination. | belem-pa-qualidade-agua-acida |
| Clogged well | Belém/PA | 102 m | Specific capacity loss, camera inspection, failed rehabilitation and plugging. | belem-pa-poco-colmatado |
| Abandoned shallow well | Belém/PA | 12 m | 12 m jetted well, 48 m³/h, contaminated by sewage and abandoned unplugged. | belem-pa-poco-raso-abandonado |
| Flowing well in the Alter do Chão aquifer | Santarém/PA | 160 m | Head above ground, 52 h test and Jacob analysis (T = 0.003 m²/s). | santarem-pa-jorrante-alter-do-chao |
| Rural hand-dug well | São Gabriel/RS | 10 m | Hand-dug well, 2024 flood, coliforms and disinfection. | sao-gabriel-rs-cacimba |
| Shallow Dunas-Barreiras well with nitrate | Extremoz/RN | 26 m | Stainless screens, flowing in 1978 and now 3 m below ground; nitrate above 10 mg/L N since 2020. | extremoz-rn-barreiras-raso |
| Fuel station monitoring well | Belém/PA | 12 m | 2" well, low-flow sampling and BTEX decline during remediation. | belem-pa-monitoramento-posto |
Use them in these docs
Writers can draw any example on a page with its id:
::well-preview{example="santarem-pa-jorrante-alter-do-chao"}
::
See Content components.
How they are checked
The @welldot/core test suite checks that every example parses, survives a serialize and parse round trip, and matches the gallery index. This site's CI validates every example a page uses.