:orphan:



.. _sphx_glr_auto_examples:

.. _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-thumbcontainer" tooltip="This example illustrates the use of sovabids on the `LEMON dataset &lt;http://fcon_1000.projects.n...">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_gui_example_thumb.png
     :alt: GUI example with LEMON dataset

     :ref:`sphx_glr_auto_examples_gui_example.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/gui_example

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates the use of sovabids on the `LEMON dataset &lt;http://fcon_1000.projects.n...">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_bidscoin_example_thumb.png
     :alt: LEMON dataset example with BIDSCOIN

     :ref:`sphx_glr_auto_examples_bidscoin_example.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/bidscoin_example

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates the use of sovabids on the `LEMON dataset &lt;http://fcon_1000.projects.n...">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_lemon_example_thumb.png
     :alt: LEMON dataset example

     :ref:`sphx_glr_auto_examples_lemon_example.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/lemon_example

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example illustrates the use of sovabids on the `LEMON dataset &lt;http://fcon_1000.projects.n...">

.. only:: html

 .. figure:: /auto_examples/images/thumb/sphx_glr_rpc_example_thumb.png
     :alt: RPC API example with the LEMON dataset

     :ref:`sphx_glr_auto_examples_rpc_example.py`

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/rpc_example
.. raw:: html

    <div class="sphx-glr-clear"></div>



.. only :: html

 .. container:: sphx-glr-footer
    :class: 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>`_