Status: placeholder. No tutorial is written yet. The titles below are planned and may change.
| Tutorial | You will learn to | Status |
|---|---|---|
| 1. Build the example engine | Build FLARE's Tests/FireEngineExample against the ERF submodule, run it, and find its output |
To be written |
| 2. Write your own engine | Start a repository with ERF as a submodule, copy the example, register a new engine, and pass the restart check | To be written |
| 3. Run a FLARE fire | Build FLARE, run a small coupled fire, and read its diagnostics | To be written |
Each tutorial will have its own page, docs/tutorial_<name>.md, with these
sections:
- Title and short introduction: what the case is and how long it takes to run.
- You will learn to / Before you start: the skills covered and what must be built first.
- The physical problem: the setup, and the known answer if there is one.
- The input file: the deck, with its main inputs explained.
- Run the case: the exact commands.
- Read the log: what to look for.
- The output: which files appear and what they hold.
- Compare with a reference: a closed-form answer or published numbers.
- Next steps: the next tutorial and related pages.