BoreTHM documentation¶
Choose a path based on what you want to do. Installation and the first command are in the project README.
Use the model¶
- Evaluate a new site: create, check and evaluate a TOML site file from the installed package.
- Interpret an assessment: status, density bounds and schedule identity.
- Python interface: public functions and classes, with units and the interface stability policy.
- Read the study summary: findings and questions for specialist discussion, also available as a two-page PDF.
Understand the science¶
- Physical models: component calculations, programme evaluation and equations.
- Validation and calibration: what the observations and analytic checks establish.
- Limitations and open questions: input uncertainties, approximations and the deferred work.
- Sources and related work: bibliography and links to data provenance.
Examine the studies¶
- Approximation comparisons: the individual physical and numerical sensitivity checks.
- Design comparisons: the evaluated interventions, remaining failures and qualification evidence.
- Breakout timing: assumed formation delays and the drilling-window opening brackets.
- Benchmark dataset: reference inputs and outputs for checking another model, with tolerances and source records.
Maintain the project¶
- Historical reviews: dated checkpoints preserved for traceability.
- Maintenance notes: implementation priorities and triggers.
- Contributing and support: changes, problem reports and questions.
Field-data descriptions and input sources stay beside their files under src/borethm/data/. They are linked from the scientific pages where needed.