Gallery
=======

SignalPlot ships a small cookbook of example scripts under :mod:`examples`.
This gallery shows the figures those scripts produce so users can see the
intended outcomes before copying patterns into their own projects.

Each image corresponds to a runnable script in ``examples/``.

Time series line
----------------

.. image:: _static/gallery/time_series.png
   :alt: Time series line example
   :class: gallery-image

Multiple line comparison
------------------------

.. image:: _static/gallery/multi_line.png
   :alt: Multiple line comparison example
   :class: gallery-image

Scatter relationship
--------------------

.. image:: _static/gallery/scatter.png
   :alt: Scatter relationship example
   :class: gallery-image

Histogram distribution
----------------------

.. image:: _static/gallery/histogram.png
   :alt: Histogram distribution example
   :class: gallery-image

Bar chart with honest scale
---------------------------

.. image:: _static/gallery/bar.png
   :alt: Bar chart with honest scale example
   :class: gallery-image

Event highlight
---------------

.. image:: _static/gallery/event_line.png
   :alt: Event highlight example
   :class: gallery-image

To regenerate these images from the repository root (requires a dev
install so **numpy** is available for the examples)::

    pip install -e ".[dev]"
    python scripts/regen_gallery.py

Each script writes into ``docs/_static/gallery/`` with the filenames above.