:orphan:

.. _general_examples:

Examples Gallery
================

Here we show some exemplary use cases for sovabids.

These examples assume the folder structure of the sovabids repository (ie having the "examples" directory).
If you plan to run these examples you should install sovabids in the following way:

Installation for using examples
-------------------------------

To be able to run all examples the easiest is to install sovabids in the 'advanced-usage' mode,
this helps to preserve that folder structure of the repository and install any additional dependencies needed for the examples.

See the `introduction section of the docs <https://sovabids.readthedocs.io/en/latest/README.html#installation-for-advanced-usage>`_ for the installation instructions.

.. contents:: Contents
   :local:
   :depth: 3



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates the use of sovabids on the LEMON dataset using the preliminary GUI too...">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_gui_example.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">GUI example with LEMON dataset</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates how does the inference of the path_pattern from a (source,target) pair...">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_example_heuristic_source_target_pair.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Usage example of source,target pair</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates the use of sovabids on the LEMON dataset using bidscoin.">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_bidscoin_example.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">LEMON dataset example with BIDSCOIN</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates the use of sovabids on the LEMON dataset using both the python API and...">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_lemon_example.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates the use of sovabids on the LEMON dataset using the RPC API.">

.. only:: html

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

  :ref:`sphx_glr_auto_examples_rpc_example.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">RPC API example with the LEMON dataset</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/gui_example
   /auto_examples/example_heuristic_source_target_pair
   /auto_examples/bidscoin_example
   /auto_examples/lemon_example
   /auto_examples/rpc_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: 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>`_