[{"data":1,"prerenderedAt":533},["ShallowReactive",2],{"page-\u002Fformat":3,"navigation":162},{"collection":4,"page":5},"docs_en",{"id":6,"title":7,"body":8,"description":152,"extension":153,"meta":154,"navigation":155,"path":157,"rawbody":158,"seo":159,"stem":160,"__hash__":161},"docs_en\u002Fformat\u002Findex.md","The .well format",{"type":9,"value":10,"toc":146},"minimark",[11,20,44,48,53,92,96,137],[12,13,14,15,19],"p",{},"A ",[16,17,18],"code",{},".well"," file is the record of one water well, written as a single JSON document. It holds what a drilling report, a well log and the well's later history hold today, in a form that software can read, check and draw: the borehole and its casing, the lithological column, pumping tests, water levels, permits, meters and water analyses.",[12,21,22,23,28,29,35,36,43],{},"The format is open (Apache 2.0) and defined by a written ",[24,25,27],"a",{"href":26},"\u002Fformat\u002Fspec","specification",". Any tool can read and write it. ",[24,30,34],{"href":31,"rel":32},"https:\u002F\u002Fwelldot.org",[33],"nofollow","welldot.org"," is one editor among them, and the ",[24,37,39,42],{"href":38},"\u002Fcore",[16,40,41],{},"@welldot\u002F*"," packages"," are one implementation.",[45,46],"well-preview",{"example":47},"estrela-doeste-sp-bauru-serra-geral",[49,50,52],"h2",{"id":51},"where-to-start","Where to start",[54,55,56,65,73,84],"card-group",{},[57,58,62],"card",{"icon":59,"title":60,"to":61},"i-lucide-file-braces","What is .well?","\u002Fformat\u002Fgetting-started\u002Fwhat-is-well",[12,63,64],{},"What a file holds, why it exists and how it relates to the spec and the packages.",[57,66,70],{"icon":67,"title":68,"to":69},"i-lucide-mountain","For geologists","\u002Fformat\u002Fgetting-started\u002Ffor-geologists",[12,71,72],{},"How a drilling report maps onto the file: lithology, construction, tests, operation, permits and water quality.",[57,74,78],{"icon":75,"title":76,"to":77},"i-lucide-code","For developers","\u002Fformat\u002Fgetting-started\u002Ffor-developers",[12,79,80,81,83],{},"Read, validate and write ",[16,82,18],{}," files from code, and what the schema guarantees.",[57,85,89],{"icon":86,"title":87,"to":88},"i-lucide-file-plus","Your first .well file","\u002Fformat\u002Fgetting-started\u002Ffirst-well-file",[12,90,91],{},"Write a small, valid file by hand and see it drawn.",[49,93,95],{"id":94},"how-this-section-is-organized","How this section is organized",[97,98,99,107,113,119,125,131],"ul",{},[100,101,102,106],"li",{},[103,104,105],"strong",{},"Getting started"," introduces the format for each kind of reader.",[100,108,109,112],{},[103,110,111],{},"Concepts"," explains the ideas the whole format rests on: depths, units, vocabularies, profiles, versions and extensions.",[100,114,115,118],{},[103,116,117],{},"Guides"," walk through tasks: writing a file, converting a report, validating, extending the format and building software on it.",[100,120,121,124],{},[103,122,123],{},"Reference"," lists every object and field (generated from the schema), links the JSON Schema and shows the example wells.",[100,126,127,130],{},[103,128,129],{},"Specification"," is the normative text, rendered as it is written in the repository. When a guide and the spec seem to differ, the spec is right.",[100,132,133,136],{},[103,134,135],{},"Changelog"," lists the revisions of the format.",[138,139,140],"note",{},[12,141,142,143,145],{},"These pages explain the format and link to the rules. The rules themselves live only in the ",[24,144,27],{"href":26},", so there is a single source to cite.",{"title":147,"searchDepth":148,"depth":148,"links":149},"",2,[150,151],{"id":51,"depth":148,"text":52},{"id":94,"depth":148,"text":95},"An open JSON format for the complete record of a water well, from construction and lithology to tests, operation, permits and water quality.","md",{},{"title":156},"Introduction","\u002Fformat","---\ntitle: The .well format\ndescription: An open JSON format for the complete record of a water well, from construction and lithology to tests, operation, permits and water quality.\nnavigation:\n  title: Introduction\n---\n\nA `.well` file is the record of one water well, written as a single JSON document. It holds what a drilling report, a well log and the well's later history hold today, in a form that software can read, check and draw: the borehole and its casing, the lithological column, pumping tests, water levels, permits, meters and water analyses.\n\nThe format is open (Apache 2.0) and defined by a written [specification](\u002Fformat\u002Fspec). Any tool can read and write it. [welldot.org](https:\u002F\u002Fwelldot.org) is one editor among them, and the [`@welldot\u002F*` packages](\u002Fcore) are one implementation.\n\n::well-preview{example=\"estrela-doeste-sp-bauru-serra-geral\"}\n::\n\n## Where to start\n\n::card-group\n\n:::card{title=\"What is .well?\" icon=\"i-lucide-file-braces\" to=\"\u002Fformat\u002Fgetting-started\u002Fwhat-is-well\"}\nWhat a file holds, why it exists and how it relates to the spec and the packages.\n:::\n\n:::card{title=\"For geologists\" icon=\"i-lucide-mountain\" to=\"\u002Fformat\u002Fgetting-started\u002Ffor-geologists\"}\nHow a drilling report maps onto the file: lithology, construction, tests, operation, permits and water quality.\n:::\n\n:::card{title=\"For developers\" icon=\"i-lucide-code\" to=\"\u002Fformat\u002Fgetting-started\u002Ffor-developers\"}\nRead, validate and write `.well` files from code, and what the schema guarantees.\n:::\n\n:::card{title=\"Your first .well file\" icon=\"i-lucide-file-plus\" to=\"\u002Fformat\u002Fgetting-started\u002Ffirst-well-file\"}\nWrite a small, valid file by hand and see it drawn.\n:::\n\n::\n\n## How this section is organized\n\n- **Getting started** introduces the format for each kind of reader.\n- **Concepts** explains the ideas the whole format rests on: depths, units, vocabularies, profiles, versions and extensions.\n- **Guides** walk through tasks: writing a file, converting a report, validating, extending the format and building software on it.\n- **Reference** lists every object and field (generated from the schema), links the JSON Schema and shows the example wells.\n- **Specification** is the normative text, rendered as it is written in the repository. When a guide and the spec seem to differ, the spec is right.\n- **Changelog** lists the revisions of the format.\n\n::note\nThese pages explain the format and link to the rules. The rules themselves live only in the [specification](\u002Fformat\u002Fspec), so there is a single source to cite.\n::\n",{"title":7,"description":152},"format\u002Findex","YOH4CyMAcc4qVJcBNUs4GjM-XL6eWtRd6Ee1DAfO6M0",{"docs_en":163,"spec":465,"changelogs":514},[164,183,202,256,353,407],{"title":165,"path":166,"stem":167,"children":168},"Ai","\u002Fai","ai",[169,171,175,179],{"title":156,"path":166,"stem":170},"ai\u002Findex",{"title":172,"path":173,"stem":174},"Converting reports with an assistant","\u002Fai\u002Fconversion-skill","ai\u002Fconversion-skill",{"title":176,"path":177,"stem":178},"llms.txt and Markdown pages","\u002Fai\u002Fllms","ai\u002Fllms",{"title":180,"path":181,"stem":182},"MCP server","\u002Fai\u002Fmcp","ai\u002Fmcp",{"title":184,"path":185,"stem":186,"children":187},"Contributing","\u002Fcontributing","contributing",[188,190,194,198],{"title":156,"path":185,"stem":189},"contributing\u002Findex",{"title":191,"path":192,"stem":193},"Writing docs","\u002Fcontributing\u002Fwriting-docs","contributing\u002F1.writing-docs",{"title":195,"path":196,"stem":197},"Update rules","\u002Fcontributing\u002Fupdate-rules","contributing\u002F2.update-rules",{"title":199,"path":200,"stem":201},"Content components","\u002Fcontributing\u002Fcomponents","contributing\u002Fcomponents",{"title":203,"path":38,"stem":204,"children":205},"Core","core",[206,208,222,250],{"title":156,"path":38,"stem":207},"core\u002Findex",{"title":209,"path":210,"stem":211,"children":212,"page":221},"Getting Started","\u002Fcore\u002Fgetting-started","core\u002F1.getting-started",[213,217],{"title":214,"path":215,"stem":216},"Installation","\u002Fcore\u002Fgetting-started\u002Finstallation","core\u002F1.getting-started\u002F1.installation",{"title":218,"path":219,"stem":220},"First use","\u002Fcore\u002Fgetting-started\u002Ffirst-use","core\u002F1.getting-started\u002F2.first-use",false,{"title":117,"path":223,"stem":224,"children":225,"page":221},"\u002Fcore\u002Fguides","core\u002F2.guides",[226,230,234,238,242,246],{"title":227,"path":228,"stem":229},"Parsing and validating","\u002Fcore\u002Fguides\u002Fparsing-and-validating","core\u002F2.guides\u002F1.parsing-and-validating",{"title":231,"path":232,"stem":233},"Serializing and sharing","\u002Fcore\u002Fguides\u002Fserializing-and-sharing","core\u002F2.guides\u002F2.serializing-and-sharing",{"title":235,"path":236,"stem":237},"Unit conversion","\u002Fcore\u002Fguides\u002Funit-conversion","core\u002F2.guides\u002F3.unit-conversion",{"title":239,"path":240,"stem":241},"Vocabularies and textures","\u002Fcore\u002Fguides\u002Fvocabularies-and-textures","core\u002F2.guides\u002F4.vocabularies-and-textures",{"title":243,"path":244,"stem":245},"Water quality vocabulary","\u002Fcore\u002Fguides\u002Fwater-quality-vocabulary","core\u002F2.guides\u002F5.water-quality-vocabulary",{"title":247,"path":248,"stem":249},"Versions and time zones","\u002Fcore\u002Fguides\u002Fversions-and-time-zones","core\u002F2.guides\u002F6.versions-and-time-zones",{"title":251,"path":252,"stem":253,"children":254},"API reference","\u002Fcore\u002Fapi","core\u002Fapi\u002Findex",[255],{"title":251,"path":252,"stem":253},{"title":257,"path":157,"stem":258,"children":259},"Format","format",[260,261,273,301,325,345,350],{"title":156,"path":157,"stem":160},{"title":209,"path":262,"stem":263,"children":264,"page":221},"\u002Fformat\u002Fgetting-started","format\u002F1.getting-started",[265,267,269,271],{"title":60,"path":61,"stem":266},"format\u002F1.getting-started\u002F1.what-is-well",{"title":68,"path":69,"stem":268},"format\u002F1.getting-started\u002F2.for-geologists",{"title":76,"path":77,"stem":270},"format\u002F1.getting-started\u002F3.for-developers",{"title":87,"path":88,"stem":272},"format\u002F1.getting-started\u002F4.first-well-file",{"title":111,"path":274,"stem":275,"children":276,"page":221},"\u002Fformat\u002Fconcepts","format\u002F2.concepts",[277,281,285,289,293,297],{"title":278,"path":279,"stem":280},"Depths and intervals","\u002Fformat\u002Fconcepts\u002Fdepths-and-intervals","format\u002F2.concepts\u002F1.depths-and-intervals",{"title":282,"path":283,"stem":284},"Units and precision","\u002Fformat\u002Fconcepts\u002Funits-and-precision","format\u002F2.concepts\u002F2.units-and-precision",{"title":286,"path":287,"stem":288},"Vocabularies","\u002Fformat\u002Fconcepts\u002Fvocabularies","format\u002F2.concepts\u002F3.vocabularies",{"title":290,"path":291,"stem":292},"Profiles","\u002Fformat\u002Fconcepts\u002Fprofiles","format\u002F2.concepts\u002F4.profiles",{"title":294,"path":295,"stem":296},"Versions and deprecation","\u002Fformat\u002Fconcepts\u002Fversions-and-deprecation","format\u002F2.concepts\u002F5.versions-and-deprecation",{"title":298,"path":299,"stem":300},"Extensibility","\u002Fformat\u002Fconcepts\u002Fextensibility","format\u002F2.concepts\u002F6.extensibility",{"title":117,"path":302,"stem":303,"children":304,"page":221},"\u002Fformat\u002Fguides","format\u002F3.guides",[305,309,313,317,321],{"title":306,"path":307,"stem":308},"Writing a .well by hand","\u002Fformat\u002Fguides\u002Fwriting-by-hand","format\u002F3.guides\u002F1.writing-by-hand",{"title":310,"path":311,"stem":312},"Converting a report","\u002Fformat\u002Fguides\u002Fconverting-a-report","format\u002F3.guides\u002F2.converting-a-report",{"title":314,"path":315,"stem":316},"Validating","\u002Fformat\u002Fguides\u002Fvalidating","format\u002F3.guides\u002F3.validating",{"title":318,"path":319,"stem":320},"Extending for your own needs","\u002Fformat\u002Fguides\u002Fextending","format\u002F3.guides\u002F4.extending",{"title":322,"path":323,"stem":324},"Building an editor or database on .well","\u002Fformat\u002Fguides\u002Fbuilding-on-well","format\u002F3.guides\u002F5.building-on-well",{"title":326,"path":327,"stem":328,"children":329},"Overview","\u002Fformat\u002Freference","format\u002F4.reference\u002Findex",[330,331,335,339],{"title":326,"path":327,"stem":328},{"title":332,"path":333,"stem":334},"JSON Schema","\u002Fformat\u002Freference\u002Fjson-schema","format\u002F4.reference\u002F1.json-schema",{"title":336,"path":337,"stem":338},"Example wells","\u002Fformat\u002Freference\u002Fexamples","format\u002F4.reference\u002F2.examples",{"title":340,"path":341,"stem":342,"children":343},"Object reference","\u002Fformat\u002Freference\u002Fobjects","format\u002Freference\u002Fobjects\u002Findex",[344],{"title":340,"path":341,"stem":342},{"title":346,"path":26,"stem":347,"children":348},"About the spec","format\u002F5.spec\u002Findex",[349],{"title":346,"path":26,"stem":347},{"title":135,"path":351,"stem":352},"\u002Fformat\u002Fchangelog","format\u002F6.changelog",{"title":354,"path":355,"stem":356,"children":357},"Render","\u002Frender","render",[358,360,370,402],{"title":156,"path":355,"stem":359},"render\u002Findex",{"title":209,"path":361,"stem":362,"children":363,"page":221},"\u002Frender\u002Fgetting-started","render\u002F1.getting-started",[364,367],{"title":214,"path":365,"stem":366},"\u002Frender\u002Fgetting-started\u002Finstallation","render\u002F1.getting-started\u002F1.installation",{"title":218,"path":368,"stem":369},"\u002Frender\u002Fgetting-started\u002Ffirst-use","render\u002F1.getting-started\u002F2.first-use",{"title":117,"path":371,"stem":372,"children":373,"page":221},"\u002Frender\u002Fguides","render\u002F2.guides",[374,378,382,386,390,394,398],{"title":375,"path":376,"stem":377},"Panels and layout","\u002Frender\u002Fguides\u002Fpanels-and-layout","render\u002F2.guides\u002F1.panels-and-layout",{"title":379,"path":380,"stem":381},"Layers and labels","\u002Frender\u002Fguides\u002Flayers-and-labels","render\u002F2.guides\u002F2.layers-and-labels",{"title":383,"path":384,"stem":385},"Theming","\u002Frender\u002Fguides\u002Ftheming","render\u002F2.guides\u002F3.theming",{"title":387,"path":388,"stem":389},"Locale and units","\u002Frender\u002Fguides\u002Flocale-and-units","render\u002F2.guides\u002F4.locale-and-units",{"title":391,"path":392,"stem":393},"Legends","\u002Frender\u002Fguides\u002Flegends","render\u002F2.guides\u002F5.legends",{"title":395,"path":396,"stem":397},"Zoom, pan and highlights","\u002Frender\u002Fguides\u002Finteraction","render\u002F2.guides\u002F6.interaction",{"title":399,"path":400,"stem":401},"Using it in a framework","\u002Frender\u002Fguides\u002Fframeworks","render\u002F2.guides\u002F7.frameworks",{"title":251,"path":403,"stem":404,"children":405},"\u002Frender\u002Fapi","render\u002Fapi\u002Findex",[406],{"title":251,"path":403,"stem":404},{"title":408,"path":409,"stem":410,"children":411},"Utils","\u002Futils","utils",[412,414,424,460],{"title":156,"path":409,"stem":413},"utils\u002Findex",{"title":209,"path":415,"stem":416,"children":417,"page":221},"\u002Futils\u002Fgetting-started","utils\u002F1.getting-started",[418,421],{"title":214,"path":419,"stem":420},"\u002Futils\u002Fgetting-started\u002Finstallation","utils\u002F1.getting-started\u002F1.installation",{"title":218,"path":422,"stem":423},"\u002Futils\u002Fgetting-started\u002Ffirst-use","utils\u002F1.getting-started\u002F2.first-use",{"title":117,"path":425,"stem":426,"children":427,"page":221},"\u002Futils\u002Fguides","utils\u002F2.guides",[428,432,436,440,444,448,452,456],{"title":429,"path":430,"stem":431},"Geometry and volumes","\u002Futils\u002Fguides\u002Fgeometry-and-volumes","utils\u002F2.guides\u002F1.geometry-and-volumes",{"title":433,"path":434,"stem":435},"Water levels and pumping tests","\u002Futils\u002Fguides\u002Fpumping-tests","utils\u002F2.guides\u002F2.pumping-tests",{"title":437,"path":438,"stem":439},"Permits","\u002Futils\u002Fguides\u002Fpermits","utils\u002F2.guides\u002F3.permits",{"title":441,"path":442,"stem":443},"Operation and production","\u002Futils\u002Fguides\u002Foperation","utils\u002F2.guides\u002F4.operation",{"title":445,"path":446,"stem":447},"Water quality","\u002Futils\u002Fguides\u002Fwater-quality","utils\u002F2.guides\u002F5.water-quality",{"title":449,"path":450,"stem":451},"Logger import","\u002Futils\u002Fguides\u002Flogger-import","utils\u002F2.guides\u002F6.logger-import",{"title":453,"path":454,"stem":455},"SIAGAS import","\u002Futils\u002Fguides\u002Fsiagas-import","utils\u002F2.guides\u002F7.siagas-import",{"title":457,"path":458,"stem":459},"Formatting","\u002Futils\u002Fguides\u002Fformatting","utils\u002F2.guides\u002F8.formatting",{"title":251,"path":461,"stem":462,"children":463},"\u002Futils\u002Fapi","utils\u002Fapi\u002Findex",[464],{"title":251,"path":461,"stem":462},[466],{"title":257,"path":157,"stem":258,"children":467,"page":221},[468],{"title":469,"path":26,"stem":470,"children":471,"page":221},"Spec","format\u002Fspec",[472,480,489],{"title":123,"path":473,"stem":474,"children":475,"page":221},"\u002Fformat\u002Fspec\u002Freference","format\u002Fspec\u002Freference",[476],{"title":477,"path":478,"stem":479},"FGDC Texture Patterns Reference","\u002Fformat\u002Fspec\u002Freference\u002Ffgdc-textures","format\u002Fspec\u002Freference\u002Ffgdc-textures",{"title":481,"path":482,"stem":483,"children":484,"page":221},"V1","\u002Fformat\u002Fspec\u002Fv1","format\u002Fspec\u002Fv1",[485],{"title":486,"path":487,"stem":488},".well File Format Specification","\u002Fformat\u002Fspec\u002Fv1\u002Fwell-format","format\u002Fspec\u002Fv1\u002Fwell-format",{"title":490,"path":491,"stem":492,"children":493,"page":221},"V2","\u002Fformat\u002Fspec\u002Fv2","format\u002Fspec\u002Fv2",[494,498,502,506,510],{"title":495,"path":496,"stem":497},".well File Format Specification — Version 2.4: Format Reference","\u002Fformat\u002Fspec\u002Fv2\u002Fformat-reference","format\u002Fspec\u002Fv2\u002Fformat-reference",{"title":499,"path":500,"stem":501},".well File Format Specification — Version 2.4: Interoperability","\u002Fformat\u002Fspec\u002Fv2\u002Finteroperability","format\u002Fspec\u002Fv2\u002Finteroperability",{"title":503,"path":504,"stem":505},".well File Format Specification — Version 2.4: Object Schemas","\u002Fformat\u002Fspec\u002Fv2\u002Fobject-schemas","format\u002Fspec\u002Fv2\u002Fobject-schemas",{"title":507,"path":508,"stem":509},".well File Format Specification — Version 2.4: Overview","\u002Fformat\u002Fspec\u002Fv2\u002Foverview","format\u002Fspec\u002Fv2\u002Foverview",{"title":511,"path":512,"stem":513},".well File Format Specification — Version 2.4: Water Quality","\u002Fformat\u002Fspec\u002Fv2\u002Fwater-quality","format\u002Fspec\u002Fv2\u002Fwater-quality",[515,521,527],{"title":203,"path":38,"stem":204,"children":516,"page":221},[517],{"title":518,"path":519,"stem":520},"@welldot\u002Fcore","\u002Fcore\u002Fchangelog","core\u002FCHANGELOG",{"title":354,"path":355,"stem":356,"children":522,"page":221},[523],{"title":524,"path":525,"stem":526},"@welldot\u002Frender","\u002Frender\u002Fchangelog","render\u002FCHANGELOG",{"title":408,"path":409,"stem":410,"children":528,"page":221},[529],{"title":530,"path":531,"stem":532},"@welldot\u002Futils","\u002Futils\u002Fchangelog","utils\u002FCHANGELOG",1793050492597]