RAPPEL : Opération de maintenance > ForgeMIA indisponible le 20 Janvier entre 7h et 12h

Commit 204a708d authored by Jerome Mariette's avatar Jerome Mariette
Browse files

workflow doc ok

parent 4147a001
......@@ -227,7 +227,7 @@ self.add_output_file_list("sais", "sai files",
<tbody>
<tr>
<td>name</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The name of the parameter. The parameter will then be available
......@@ -236,7 +236,7 @@ self.add_output_file_list("sais", "sai files",
<tr>
<td>help</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The help message prompted to the user.</td>
......@@ -349,7 +349,7 @@ self.add_output_file_list("sais", "sai files",
<tbody>
<tr>
<td>name</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The name of the parameter</td>
......@@ -357,7 +357,7 @@ self.add_output_file_list("sais", "sai files",
<tr>
<td>help</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The help message prompted to the user.</td>
......@@ -472,7 +472,7 @@ self.add_output_file_list("sais", "sai files",
<tbody>
<tr>
<td>name</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The name of the parameter</td>
......@@ -480,7 +480,7 @@ self.add_output_file_list("sais", "sai files",
<tr>
<td>help</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The help message prompted to the user.</td>
......@@ -556,7 +556,7 @@ self.add_output_file_list("sais", "sai files",
<tbody>
<tr>
<td>name</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The name of the parameter</td>
......@@ -564,7 +564,7 @@ self.add_output_file_list("sais", "sai files",
<tr>
<td>help</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The help message prompted to the user.</td>
......@@ -662,7 +662,7 @@ self.add_output_file_list("sais", "sai files",
<tbody>
<tr>
<td>name</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The name of the parameter</td>
......@@ -670,7 +670,7 @@ self.add_output_file_list("sais", "sai files",
<tr>
<td>help</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>The help message prompted to the user.</td>
......@@ -758,7 +758,7 @@ self.add_output_file_list("sais", "sai files",
<tbody>
<tr>
<td>pattern</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>Pattern is a regepx string used to retrieve the ouput files. </td>
......@@ -828,7 +828,7 @@ def parse(self, component_file):
<tbody>
<tr>
<td>component_file</td>
<td>str</td>
<td>string</td>
<td>true</td>
<td>None</td>
<td>This is the file in which the external component is defined.</td>
......
......@@ -68,7 +68,8 @@
<!--Nav Bar -->
<nav class="col-xs-3 bs-docs-sidebar">
<ul id="sidebar" class="nav nav-stacked fixed">
<li><a href="#workflow-architecture" class="active">Where to add a new workflow</a></li>
<li><a href="#what" class="active">What is a workflow</a></li>
<li><a href="#workflow-architecture">Where to add a new workflow</a></li>
<li><a href="#workflow" >The Workflow class</a></li>
<li><a href="#define_parameters">Define parameters</a>
<ul class="nav nav-stacked">
......@@ -84,6 +85,14 @@
</nav>
<div class="col-xs-12 col-sm-9">
<section id="what" class="group">
<h1 class="page-header">What is a workflow</h1>
<p>A workflow is a collection of <a href="./jflow-core-component.html">components</a>. In jflow, it is represented by a Python class
inerhiting from <code>jflow.workflow.Workflow</code>. It lists all the inputs and parameters that should be requested to
the final user and build the execution process by adding components and linking them to each others.</p>
</section>
<section id="workflow-architecture" class="group">
<h1 class="page-header">Where to add a new workflow</h1>
<p>New wokflow must be added as a new python package in the <code>workflows</code> package. The implementation of
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment