Official Boulder example catalog derived from the Cantera Python reactor samples.
Each runnable example is provided as a STONE YAML file that opens in the Boulder GUI. Unsupported upstream samples are listed in the catalog with an explicit technical reason.
Runnable YAML files under examples/ are produced with Boulder’s sim2stone tool:
sim2stone upstream/cantera/reactors/<script>.py -o examples/<name>.yaml --mechanism <mech>Or regenerate the whole runnable set:
python scripts/generate_examples.pyUpstream scripts are vendored unchanged under upstream/cantera/reactors/ at a pinned
Cantera commit recorded in examples/manifest.yaml.
conda env create -n boulder -f environment.yml
conda activate boulder
make test
make docs-buildLaunch an example in the GUI:
boulder examples/combustor.yaml --no-openHeadless download of the generated Cantera Python script:
boulder examples/reactor2.yaml --headless --download /tmp/reactor2.py
python /tmp/reactor2.pyEach runnable example has its own devcontainer config under .devcontainer/<id>/
(generated by python scripts/build_devcontainers.py) that launches Boulder
already running that example, with port 8050 forwarded and opened in your
browser automatically. Use one of the launch links below, or open this
repository in the default Codespace (.devcontainer/devcontainer.json) and run:
boulder examples/<example>.yaml --no-open --host 0.0.0.0One-click Codespaces launches — each opens this example running in Boulder; the forwarded port opens in your browser automatically.
- Steady combustor residence time
- Piston reactor with heat transfer
- Nanosecond pulse discharge
- Mixer with two inlet streams
- Constant-pressure ignition
- Periodic CSTR
- Fuel injection with Gaussian pulse
- Continuous reactor temperature sweep
Sphinx docs live under docs/. The catalog lists upstream provenance, adaptation
notes, and Codespaces launch commands for each example.
make testIntegration tests assert that every runnable YAML validates and that Boulder’s headless
--download Python script executes successfully (with documented skips for known-hard cases).
MIT — see LICENSE. Vendored Cantera samples remain under their upstream
BSD-3-Clause license in the upstream/ tree.