:orphan:

Code Examples
=============

This section contains code examples for using some of the functionality within CAF.toolkit.

.. attention::
    The code examples are currently work-in-progress, if you have any
    suggestions for examples please consider raising an issue on
    `GitHub <https://github.com/Transport-for-the-North/caf.toolkit/issues>`__.

.. note::
   - For quick start guide see :ref:`quick start`
   - For more in-depth user guide and tutorial see :ref:`user guide`
   - For details on the package API see :ref:`module api documentation`



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is an example of a code example which is displayed and ran.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_run_example_thumb.png
    :alt:

  :ref:`sphx_glr_examples_run_example.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Ran Example</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This is an example of a code example which is displayed but not ran.">

.. only:: html

  .. image:: /examples/images/thumb/sphx_glr_example_thumb.png
    :alt:

  :ref:`sphx_glr_examples_example.py`

.. raw:: html

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


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /examples/run_example
   /examples/example


.. 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: examples_python.zip </examples/examples_python.zip>`

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

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


.. only:: html

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

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