.. _tigrestutorial:

.. currentmodule:: tigres

Basic Templates Tutorial
************************
The Tigres Python API allows you to compose a workflow as a python application. Tasks may
be an executable or python function. In this tutorial, you will learn how to
a) set up your Tigres environment, b) use each Tigres template, c) define data dependencies
between tasks, d) log messages and e) query the tigres logs. For the sake of simplicity,
the tasks in this tutorial will be python functions.

This tutorial uses three programs which can be found `here
<https://bitbucket.org/berkeleylab/tigres/downloads>`_ in a file named
tigres-|release|-tutorials.zip . Each program has the same final
output but uses different methods to produce it. The example workflows
chosen for this tutorial perform string manipulation. The example
functions are intentionally kept simple for allowing us to focus on
the Tigres components in this tutorial.  Real world examples can be
plugged in similarly with any of the Tigres templates

.. contents::
    :depth: 1
    :local:
    :backlinks: top

Before starting the tutorials, follow the :ref:`environment-setup` instructions to prepare
your environment for Tigres workflow execution.


.. _datamodelandexecution:

Data Model and Execution
========================

.. include:: includes/data_model_and_execution.rst

.. _helloworldparallel:

Parallel
========
:strong:`(a parallel template example)`

.. include:: includes/basic_template_tutorial_parallel.rst


Sequence
========
:strong:`(a sequence template example)`

.. include:: includes/basic_template_tutorial_sequence.rst

.. _splitandmerge:

Split and Merge
===============
:strong:`(a example using split and merge templates)`

.. include:: includes/basic_template_tutorial_split_merge.rst