:orphan:

.. _tutorial_source_readme:

Tutorials
=========

Step-by-step tutorials for learning SUEWS urban climate modelling using the
modern Python interface. Each tutorial combines executable code with detailed
explanations.

.. note::

   **Tutorial formats**: Each tutorial is available as a Python script (``.py``)
   with percent-format documentation, or as an auto-generated Jupyter notebook
   (``.ipynb``) for interactive use.

   **Requirements**: Tutorials require SuPy. See :doc:`/installation` for setup.



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Essential SUEWS workflow using the modern SuPy (Python) interface.">

.. only:: html

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

  :doc:`/auto_examples/tutorial_01_quick_start`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">SUEWS Quick Start Tutorial</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Configure SUEWS parameters for a custom research location.">

.. only:: html

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

  :doc:`/auto_examples/tutorial_02_setup_own_site`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Set Up SUEWS for Your Own Site</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Set up proper initial states for realistic SUEWS simulations.">

.. only:: html

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

  :doc:`/auto_examples/tutorial_03_initial_conditions`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Preparing Initial Conditions</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Sensitivity analysis for urban climate modelling with SUEWS.">

.. only:: html

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

  :doc:`/auto_examples/tutorial_04_impact_studies`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Impact Studies Using SuPy</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Comprehensive analysis and validation of SUEWS outputs.">

.. only:: html

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

  :doc:`/auto_examples/tutorial_05_results_analysis`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Analysing Simulation Results</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Coupling SUEWS with external models for anthropogenic heat flux.">

.. only:: html

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

  :doc:`/auto_examples/tutorial_06_external_coupling`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">External Model Coupling</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/tutorial_01_quick_start
   /auto_examples/tutorial_02_setup_own_site
   /auto_examples/tutorial_03_initial_conditions
   /auto_examples/tutorial_04_impact_studies
   /auto_examples/tutorial_05_results_analysis
   /auto_examples/tutorial_06_external_coupling


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: auto_examples_python.zip </auto_examples/auto_examples_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip </auto_examples/auto_examples_jupyter.zip>`


.. only:: html

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

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