Skip to content

[ENH] Add canonical borehole data format and comprehensive import guide#40

Open
Leguark wants to merge 3 commits intomainfrom
wells_docs
Open

[ENH] Add canonical borehole data format and comprehensive import guide#40
Leguark wants to merge 3 commits intomainfrom
wells_docs

Conversation

@Leguark
Copy link
Copy Markdown

@Leguark Leguark commented Mar 12, 2026

[DOC] Add comprehensive guide and example data for importing borehole datasets in canonical format

  • Introduced GUIDE.md and WELLS_DOC.md for detailed documentation on borehole data structures and import workflows
  • Added canonical example datasets (collars.csv, survey.csv, lithology.csv, assays.csv) under examples/data/borehole_canonical/
  • Created unit tests (test_canonical_reading.py, test_canonical_assays.py) to verify reading of canonical-format borehole datasets

[DOC] Expand documentation with corner case handling and advanced configuration options

  • Enhanced GUIDE.md with detailed corner case scenarios and validations for all borehole data file types
  • Added comprehensive behavior clarifications for missing columns, angle normalization, duplicate handling, and depth processing
  • Included Python examples covering canonical, non-canonical, and advanced configurations with GenericReaderFilesHelper
  • Provided troubleshooting section with common errors and solutions for borehole data import workflows

Leguark added 3 commits March 12, 2026 08:54
… datasets in canonical format

- Introduced `GUIDE.md` and `WELLS_DOC.md` for detailed documentation on borehole data structures and import workflows.
- Added canonical example datasets (`collars.csv`, `survey.csv`, `lithology.csv`) under `examples/data/borehole_canonical/`.
- Created unit test (`test_canonical_reading.py`) to verify reading of canonical-format borehole datasets.
…h assay-specific guidelines

- Added `assays.csv` to canonical dataset examples under `examples/data/borehole_canonical/`.
- Implemented `test_canonical_assays.py` to validate assay data integration in borehole workflows.
- Expanded `GUIDE.md` with detailed assay-specific data structure explanations and usage guidelines.
…or borehole data files in `GUIDE.md`

- Expanded `GUIDE.md` with corner case scenarios and validations for `collars.csv`, `survey.csv`, `lithology.csv`, and `assays.csv`.
- Clarified behavior for missing or incorrect columns, normalization of inclination/azimuth, and handling of duplicate entries.
- Added Python examples covering canonical, non-canonical, and advanced configurations with `GenericReaderFilesHelper`.
- Included troubleshooting tips and advanced reader settings for complex data formats.
Copy link
Copy Markdown
Author

Leguark commented Mar 12, 2026

This stack of pull requests is managed by Graphite. Learn more about stacking.

@Leguark Leguark changed the title [DOC] Add comprehensive guide and example data for importing borehole datasets in canonical format [ENH] Add canonical borehole data format and comprehensive import guide Mar 12, 2026
@Leguark Leguark marked this pull request as ready for review March 12, 2026 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant