Welcome to the PyCFAST documentation

PyCFAST is a Python interface for the Consolidated Fire and Smoke Transport (CFAST) fire simulation software, providing an easy-to-use Python programming interface for building and running fire scenarios. It allows researchers and engineers to automate CFAST runs, build and modify input files programmatically, execute simulations, and analyze results using the broader Python ecosystem.

Motivation

CFAST is a long-established fire modeling software written in Fortran and traditionally run through its graphical interface (CEdit). This reliance on a GUI can make large parametric studies, automation, and reproducibility cumbersome.

PyCFAST was originally developed internally at Orano to integrate CFAST with the Python scientific ecosystem (notably for the scipy.optimize module), and complements existing tools like CData by exposing every CFAST component programmatically.

User Guide

• Installation
• Getting Started
• Examples

Reference

• API
  • CFASTModel
  • CFAST Components
  • Parser
  • Datasets

Development

• Contributing Guide
• Changelog

Other

• Acknowledgments
• License
• Citation