annotate rpthermo.xml @ 3:0d32c50d9db7 draft default tip

planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
author tduigou
date Fri, 18 Nov 2022 16:21:05 +0000
parents ec49df43ffae
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
1 <tool id="rpthermo" name="Thermo" version="@TOOL_VERSION@" profile="21.09">
0
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
2 <description>Calculate the formation energy of chemical species and the Gibbs free energy of their reactions and pathways in an SBML</description>
1
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
3 <macros>
2
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
4 <token name="@TOOL_VERSION@">6.0.1</token>
1
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
5 </macros>
0
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
6 <requirements>
1
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
7 <requirement type="package" version="@TOOL_VERSION@">rptools</requirement>
0
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
8 </requirements>
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
9 <stdio>
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
10 <regex match="WARNING:" level="warning" />
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
11 <regex match="ERROR:" level="fatal" />
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
12 <regex match="ERROR:root:ChemAxon" level="warning" />
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
13 </stdio>
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
14 <command detect_errors="exit_code"><![CDATA[
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
15 python -m rptools.rpthermo
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
16 '$input'
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
17 '$pathway_with_thermo'
1
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
18 --pH '$adv.ph'
0
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
19 --ionic_strength '$adv.ionic_strength'
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
20 --pMg '$adv.pMg'
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
21 ]]></command>
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
22 <inputs>
2
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
23 <param name="input" type="data" format="sbml" label="SBML Input File" help="Pathways in SBML format" />
0
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
24 <section name="adv" title="Advanced Options" expanded="false">
1
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
25 <param name="ph" type="float" value="7.5" min="0" max="14" label="Compartment pH of the pathway" />
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
26 <param name="ionic_strength" type="float" value="0.25" min="0" max="500" label="Compartment ionic strength of the pathway" />
2
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
27 <param name="pMg" type="float" value="3.0" label="Compartment pMg (Magnesium vapor pressure) of the pathway" />
0
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
28 </section>
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
29 </inputs>
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
30 <outputs>
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
31 <data name="pathway_with_thermo" format="xml" label="${tool.name} - ${input.name}" />
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
32 </outputs>
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
33 <tests>
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
34 <test>
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
35 <!-- test 1: check if identical outputs are produced with default parameters -->
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
36 <param name="input" value="rp_013_0001.xml" />
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
37 <param name="model" value="e_coli_iML1515.sbml" />
1
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
38 <output name="pathway_with_thermo" file="rp_013_0001_with_thermo.xml" ftype="xml" compare="diff" sort="true" >
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
39 <assert_contents>
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
40 <is_valid_xml />
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
41 <!--check thermo_dG0_prime value-->
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
42 <has_text text="-2308.11630" />
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
43 <!--check thermo_dG value-->
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
44 <has_text text="-2151.84763" />
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
45 <has_n_lines n="483" />
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
46 </assert_contents>
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
47 </output>
0
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
48 </test>
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
49 </tests>
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
50 <help><![CDATA[
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
51 Thermodynamics
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
52 ===============
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
53 Calculate the formation energy of chemical species either using an internal database or estimate it by decomposing them using the `component contribution <https://gitlab.com/elad.noor/component-contribution>`_ method. Thereafter this tool predicts the Gibbs free energy of reactions and of the whole heterologous pathway by combining the formation energy of each individual compound.
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
54
2
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
55 The goal of the thermodynamic analysis is to estimate the feasibility of the predicted pathways toward target production, in physiological conditions (PH, ionic strength).
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
56
0
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
57 .. image:: https://raw.githubusercontent.com/Galaxy-SynBioCAD/rpThermo/standalone/galaxy/img/rpThermo.png
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
58 :width: 80 %
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
59 :align: center
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
60
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
61
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
62 |
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
63
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
64
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
65 Above is an illustration of the Gibbs free energy calculation using the component contribution package. The color-coded arrows from red (best) to blue (worst) show the best and worst-performing reactions.
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
66
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
67 Required:
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
68
2
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
69 Inputs
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
70 ------
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
71
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
72 * **SBML Input File**\ : Pathways in SBML format
0
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
73
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
74 Advanced Options:
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
75
2
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
76 * **PH**\ :(float) Compartment PH of the pathway
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
77 * **Ionic strength**\ :(float) Compartment ionic strength of the pathway
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
78 * **pMg**\ :(float) Compartment pMg (Magnesium vapor pressure) of the pathway
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
79
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
80 Output
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
81 ------
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
82
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
83 * **Pathway with thermo**\ : annotated pathways (with thermodynamics information for each reaction) in SBML(Systems Biology Markup Language) format.
0
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
84
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
85 Project Links
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
86 ---------------------
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
87
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
88 * `GitHub <https://github.com/brsynth/rptools/tree/master/rptools/rpthermo>`_
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
89
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
90 Acknowledgments
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
91 ---------------
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
92
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
93 * Thomas Duigou
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
94 * Joan Hérisson
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
95
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
96 ]]></help>
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
97 <citations>
1
862dd1b34906 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
98 <citation type="doi">10.1371/journal.pcbi.1003098</citation>
0
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
99 </citations>
2
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
100 <creator>
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
101 <person givenName="Melchior" familyName="du Lac" identifier="https://orcid.org/0000-0002-9984-4689" />
ec49df43ffae planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 1
diff changeset
102 </creator>
0
e56ba3389af5 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
103 </tool>