[ENH] Add canonical borehole data format and comprehensive import guide#40
Open
[ENH] Add canonical borehole data format and comprehensive import guide#40
Conversation
… 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.
Author
This stack of pull requests is managed by Graphite. Learn more about stacking. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

[DOC] Add comprehensive guide and example data for importing borehole datasets in canonical format
GUIDE.mdandWELLS_DOC.mdfor detailed documentation on borehole data structures and import workflowscollars.csv,survey.csv,lithology.csv,assays.csv) underexamples/data/borehole_canonical/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
GUIDE.mdwith detailed corner case scenarios and validations for all borehole data file typesGenericReaderFilesHelper