Tutorials and Workflow¶
DFODE-kit is intended to support a workflow like:
- Sample states from canonical flames
- Augment underrepresented thermochemical regions
- Label with CVODE/Cantera
- Train a surrogate model
- Validate in a priori / a posteriori simulations
- Deploy in DeepFlame / CFD workflows
Existing tutorial assets¶
The repository already includes notebook-based tutorial material under:
tutorials/oneD_freely_propagating_flame/tutorials/twoD_HIT_flame/
Documentation direction¶
A future docs iteration can bring notebook tutorials into the published site, but this first MkDocs setup focuses on:
- lightweight Markdown docs,
- repository architecture,
- CLI guidance,
- agent and maintainer workflow documentation.
Practical workflow entry points¶
For reproducible command-line usage, use the published Markdown docs in this order:
- Getting Started
- CLI
- Canonical Case Initialization
- Runtime Configuration and Case Execution
- Data Preparation and Training Workflow
That sequence reflects the currently validated path from case creation to sampled/training-ready datasets.