:orphan:

.. _examples_gallery:

This section contains examples that showcase how to use the various features of PyCFAST within the Python ecosystem across notable libraries and use cases.

The examples below are generated automatically from the scripts in
`examples <https://github.com/bewygs/pycfast/tree/main/examples>`_.


.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to create a basic CFAST fire simulation model using PyCFAST. We&#x27;ll build a complete simulation with two compartments, ventilation, fire sources, and target devices.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_01_basic_usage_thumb.png
    :alt:

  :doc:`/auto_examples/plot_01_basic_usage`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">01 Basic usage</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example explains how to use PyCFAST&#x27;s parser to read and analyze existing CFAST input files (.in) to a CFASTModel object. This allows users to use their existing models, modify them, and re-run simulations with minimal effort.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_02_parsing_cfast_input_files_thumb.png
    :alt:

  :doc:`/auto_examples/plot_02_parsing_cfast_input_files`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">02 Parsing Existing CFAST Input Files</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to use PyCFAST with NumPy to generate simulation data by running multiple CFAST fire simulations with varying parameters.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_03_generating_data_thumb.png
    :alt:

  :doc:`/auto_examples/plot_03_generating_data`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">03 Generating Data with PyCFAST</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to perform sensitivity analysis on CFAST fire simulation models using the SALib library. We&#x27;ll use Sobol indices to quantify parameter importance and visualize the results.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_04_sensitivity_analysis_thumb.png
    :alt:

  :doc:`/auto_examples/plot_04_sensitivity_analysis`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">04 Sensitivity Analysis</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to use optimization algorithms to find the best parameter values for CFAST fire simulations.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_05_optimization_thumb.png
    :alt:

  :doc:`/auto_examples/plot_05_optimization`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">05 Operational research with optimization algorithms</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip=" This example demonstrates how to build machine-learning surrogate models to predict CFAST outputs instantly instead of running full simulations.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_06_surrogate_models_thumb.png
    :alt:

  :doc:`/auto_examples/plot_06_surrogate_models`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">06 Surrogate Models with Machine Learning</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to use parallel computing on a cluster to accelerate CFAST fire simulations using PyCFAST and Dask.">

.. only:: html

  .. image:: /auto_examples/images/thumb/sphx_glr_plot_07_parallel_computing_thumb.png
    :alt:

  :doc:`/auto_examples/plot_07_parallel_computing`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">07 Parallel Computing on Clusters</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_01_basic_usage
   /auto_examples/plot_02_parsing_cfast_input_files
   /auto_examples/plot_03_generating_data
   /auto_examples/plot_04_sensitivity_analysis
   /auto_examples/plot_05_optimization
   /auto_examples/plot_06_surrogate_models
   /auto_examples/plot_07_parallel_computing



.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_