:orphan:

# Gallery

Working examples of GAT's plotting functions, each driven by an
in-repo fixture so you can run them locally without provisioning a
project.

## Where the data comes from

Most examples use the Sienna RTS-GMLC fixture at
`example_data/sienna/v4/`. It's a one-week unit-commitment run on the
modified RTS-GMLC test case, generated by the Dockerized
`PowerSimulations.jl` pipeline at `docker/sienna/`. To regenerate:

```bash
make sienna-fixture-v4
```

The transmission example (`09_transmission_loading.py`) uses the Plexos
fixture at `example_data/plexos/` because the Sienna fixture is built
with `CopperPlatePowerModel` and therefore has no line-flow data.

## Running an example

The examples are plain Python scripts. From `docs/gat_examples/`:

```bash
python 01_dispatch_annual_system.py
```

Or open in Jupyter and step through the cells. They each instantiate a
scenario directly and pass it to a `gat.quickplots` function.

## Note on construction

The examples instantiate `SiennaScenario` / `PlexosScenario` directly
because they're path-based demos. Production code should use
`gat.load(...)` to obtain a scenario object via the supported v1 entry
point — see [Python API: Loading Projects and
Scenarios](../python_api_load.md).


.. 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="The average dispatch shape over a 24-hour day, computed by grouping the timeseries by hour-of-day and taking the mean. Useful for characterizing typical daily ramps (morning load pickup, solar midday, evening peak).">

.. only:: html

  .. image:: /gat_plot_examples/images/thumb/sphx_glr_05_dispatch_mean_hourly_thumb.png
    :alt:

  :doc:`/gat_plot_examples/05_dispatch_mean_hourly`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Mean Hourly Dispatch Profile</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Faceted view: one annual stack subplot per area in the system. Each facet shows the same generation-by-tech stack as the system-wide view, restricted to a single area.">

.. only:: html

  .. image:: /gat_plot_examples/images/thumb/sphx_glr_03_dispatch_area_facets_thumb.png
    :alt:

  :doc:`/gat_plot_examples/03_dispatch_area_facets`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Per-Area Dispatch Facets</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Stacked monthly totals of generation by technology. Useful for spotting seasonality in dispatch (e.g., gas peaking in summer, hydro spring runoff) without the high-frequency noise of an hourly view.">

.. only:: html

  .. image:: /gat_plot_examples/images/thumb/sphx_glr_02_dispatch_monthly_system_thumb.png
    :alt:

  :doc:`/gat_plot_examples/02_dispatch_monthly_system`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Monthly System Dispatch</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Installed capacity by technology, sourced directly from the system definition (not the simulation results). This is a useful sanity-check view: what&#x27;s actually in the model before any dispatch happens.">

.. only:: html

  .. image:: /gat_plot_examples/images/thumb/sphx_glr_07_capacity_overview_thumb.png
    :alt:

  :doc:`/gat_plot_examples/07_capacity_overview`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Generation Capacity Overview</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Side-by-side stacked-area views around the timestamps of system-wide peak and minimum demand. Each subplot shows a ±3-day window centered on the event so you can see the dispatch ramp into and out of the peak/trough.">

.. only:: html

  .. image:: /gat_plot_examples/images/thumb/sphx_glr_04_dispatch_window_peak_min_thumb.png
    :alt:

  :doc:`/gat_plot_examples/04_dispatch_window_peak_min`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Peak and Minimum Demand Windows</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Stacked time series of curtailed VRE energy by technology. The annual view shows total curtailed MWh; the monthly view shows seasonality.">

.. only:: html

  .. image:: /gat_plot_examples/images/thumb/sphx_glr_06_curtailment_annual_thumb.png
    :alt:

  :doc:`/gat_plot_examples/06_curtailment_annual`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Curtailment — Annual and Monthly</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A stacked area plot of system-wide generation by technology over the fixture&#x27;s full horizon, with the load curve overlaid.">

.. only:: html

  .. image:: /gat_plot_examples/images/thumb/sphx_glr_01_dispatch_annual_system_thumb.png
    :alt:

  :doc:`/gat_plot_examples/01_dispatch_annual_system`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Annual System Dispatch Stack</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Two transmission views:">

.. only:: html

  .. image:: /gat_plot_examples/images/thumb/sphx_glr_09_transmission_loading_thumb.png
    :alt:

  :doc:`/gat_plot_examples/09_transmission_loading`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Transmission Line Loading and Utilization</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Two complementary views of the load shape:">

.. only:: html

  .. image:: /gat_plot_examples/images/thumb/sphx_glr_08_load_heatmap_thumb.png
    :alt:

  :doc:`/gat_plot_examples/08_load_heatmap`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Load Heatmap and Duration Curve</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /gat_plot_examples/05_dispatch_mean_hourly
   /gat_plot_examples/03_dispatch_area_facets
   /gat_plot_examples/02_dispatch_monthly_system
   /gat_plot_examples/07_capacity_overview
   /gat_plot_examples/04_dispatch_window_peak_min
   /gat_plot_examples/06_curtailment_annual
   /gat_plot_examples/01_dispatch_annual_system
   /gat_plot_examples/09_transmission_loading
   /gat_plot_examples/08_load_heatmap


.. 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: gat_plot_examples_python.zip </gat_plot_examples/gat_plot_examples_python.zip>`

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

      :download:`Download all examples in Jupyter notebooks: gat_plot_examples_jupyter.zip </gat_plot_examples/gat_plot_examples_jupyter.zip>`


.. only:: html

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

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