Skip to content

Getting Started with PyFDS

Welcome to PyFDS! This guide will help you get up and running with creating, executing, and analyzing FDS fire simulations using Python.

What You'll Learn

Prerequisites

Before you begin, you should have:

  • Python 3.11 or higher installed on your system
  • Basic Python knowledge (variables, functions, classes)
  • Optional: FDS installed if you want to execute simulations

New to Python?

If you're new to Python, we recommend completing a basic Python tutorial first. Good resources include:

Typical Workflow

Here's what a typical PyFDS workflow looks like:

graph LR
    A[Create Simulation] --> B[Add Components]
    B --> C[Validate]
    C --> D{Valid?}
    D -->|Yes| E[Write FDS File]
    D -->|No| F[Fix Errors]
    F --> B
    E --> G[Execute FDS]
    G --> H[Analyze Results]
    H --> I[Visualize Data]
  1. Create a simulation object with metadata
  2. Add components (mesh, geometry, fires, devices)
  3. Validate the configuration
  4. Write the FDS input file
  5. Execute the simulation (optional)
  6. Analyze the results (optional)
  7. Visualize the data (optional)

Learning Path

We recommend following this learning path:

Start Here

Begin with Installation to set up PyFDS on your system.

Build Your First Simulation

Follow the Quick Start Tutorial to create a simple room fire simulation.

Understand the Basics

Read Key Concepts to understand FDS fundamentals and PyFDS architecture.

Explore Features

Dive into the User Guide to learn about specific features and capabilities.

Learn from Examples

Study the Examples to see real-world applications.

Reference Documentation

Use the API Reference when you need detailed information about specific classes and methods.

Resource Description
Installation Install PyFDS and dependencies
Quick Start Your first simulation in 5 minutes
Key Concepts Understanding PyFDS fundamentals
User Guide Comprehensive feature documentation
Examples Real-world code examples
FAQ Frequently asked questions
Troubleshooting Common issues and solutions

Getting Help

If you get stuck, here's where to find help:

Ready to begin? Let's install PyFDS!