:orphan:

Examples
========

AgriFoodPy implements models and table manipulation methods to analyse and
process agrifood data. In these examples we demonstrate the use of some of these
methods and models using python scripts, or a console script.

.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

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

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>

Command line tool
-----------------

``agrifoodpy`` is a command line script that runs a pipeline of functions
defined in a config file.

.. code-block:: console
    
    $ agrifoodpy examples/cli/scaling_food_supply.yml -o results.json

For more information on how to configure a pipeline using configuration files
and execute them using the ``agrifoodpy`` command line tool, see
:ref:`config_file`.

.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

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

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>


Modules
-------

Basic module accesor usage

.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to combine different land data arrays using the land accessor and how to use the carbon sequestration model to compute additional carbon sequestration from reforested land.">

.. only:: html

  .. image:: /examples/modules/images/thumb/sphx_glr_plot_reforest_ALC_4_5_thumb.png
    :alt:

  :doc:`/examples/modules/plot_reforest_ALC_4_5`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Reforest half of UK's ALC 4 and 5 pasture land</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Two datasets are imported from the agrifoodpy_data package:">

.. only:: html

  .. image:: /examples/modules/images/thumb/sphx_glr_plot_emissions_animal_scaling_thumb.png
    :alt:

  :doc:`/examples/modules/plot_emissions_animal_scaling`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot emissions from different item groups and years</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Consumption of animal based products is halved, while keeping total comsumed weight constant by upscaling the consumption of vegetal products.">

.. only:: html

  .. image:: /examples/modules/images/thumb/sphx_glr_plot_animal_consumption_scaling_thumb.png
    :alt:

  :doc:`/examples/modules/plot_animal_consumption_scaling`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Reducing UK's animal product consumption</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


Pipeline
--------

Basic pipeline examples

.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates the use of the pipeline manager to create a simple pipeline of modules.">

.. only:: html

  .. image:: /examples/pipeline/images/thumb/sphx_glr_plot_balanced_scaling_food_balance_sheet_pipeline_thumb.png
    :alt:

  :doc:`/examples/pipeline/plot_balanced_scaling_food_balance_sheet_pipeline`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Building a Food Balance Sheet Pipeline</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /examples/cli/index.rst
   /examples/modules/index.rst
   /examples/pipeline/index.rst



.. only:: html

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

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