:orphan:

..
   This file is used by sphinx-gallery to provide an introduction on the
   gallery landing page. It is not meant to be part of the toctree.

:orphan:

Examples
========

This gallery showcases example scripts demonstrating how to use this package in common scenarios.

Each example is a self-contained Python script that can be viewed in the documentation and executed locally.

Tips
----
- Read the narrative text above each code block for context and explanations.
- Click the "Download" links on example pages to obtain the source files.
- To run an example locally, ensure the package and optional dependencies are installed.

Install the docs dependencies (which include plotting backends) with:

.. code-block:: bash

   python -m pip install -e '.[docs]'

Then run a script, for example from the repository root:

.. code-block:: bash

   python docs/examples/plot_basic.py





.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates using the cocofeats.add function.">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_plot_basic.py`

.. raw:: html

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


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/plot_basic



.. only:: html

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

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