User guide

This section covers compiling user models with the native CLI, running existing OpenPFC applications and using the configuration-driven frontend. It assumes you have an installed SDK or a working source build.

For installation use INSTALL.md. To check the SDK, run a starter model and inspect its results, use Start here.

Run applications

Topic	Document
Compile user models or run catalogued cases	Native CLI workflow
Available binaries and sample inputs	Applications
Configuration vocabulary	Configuration
JSON/TOML to runtime objects	Application pipeline
Parameter validation and diagnostics	Parameter validation
Custom time-stepper integration	Custom stepper integration

Exact configuration keys belong in the Spectral App configuration reference.

Work with results

Topic	Document
Writers and result files	Result files
Read raw binary fields with external tools	Post-process binary fields
Figures mapped to runnable programs	Showcase

The exact binary layout is specified in Binary field file layout.

Continue by goal

• For a full run-to-visualization walkthrough, use End-to-end visualization.

• For a batch-system workflow, use the HPC operator guide.

• For an application in another repository, use Minimal custom application.

• For new models, modifiers, or writers, use Extending OpenPFC.