annotate editconf.xml @ 2:70bb58127c6a draft

Uploaded
author flepiane
date Tue, 29 Jun 2021 01:02:47 +0000
parents 4ec90cb2fec0
children a21fac95d092
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
1 <tool id="gmx_editconf_daimoners" name="GROMACS structure configuration daimoners edition" version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@">
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
2 <description>using editconf</description>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
3 <macros>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
4 <token name="@GALAXY_VERSION@">0</token>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
5 <import>macros.xml</import>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
6 </macros>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
7
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
8 <expand macro="requirements" />
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
9
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
11
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
12
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
13 ln -s '$input_file' ./input.$input_file.ext &&
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
14 gmx genconf
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
15 -f ./input.$input_file.ext
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
16 -o ./output.${output_format}
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
17 -nbox ($box $box $box)
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
18 -dist ($dist $dist $dist)
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
19 &>> verbose.txt &&
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
20
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
21 cp ./output.${output_format} '$output'
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
22
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
23 ]]></command>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
24
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
25 <inputs>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
26 <param argument="input_file" type="data" format='gro,pdb' label="Input structure"/>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
27 <param argument="output_format" type="select" label="Output format">
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
28 <option value="gro">GRO file</option>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
29 <option value="pdb">PDB file</option>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
30 </param>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
31 <param argument="box" type="float" label="Box dimensions in nanometers" value="0.0" min="0.0" max="1000.0" help="Dimensions of the box in which simulation will take place" />
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
32 <param argument="dist" type="float" label="Distance in nanometers" value="0.0" min="0.0" max="10.0" help="Distance between different instance of the molecule" />
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
33
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
34 <expand macro="log" />
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
35
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
36 </inputs>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
37 <outputs>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
38 <data name="output" format="gro">
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
39 <change_format>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
40 <when input="output_format" value="gro" format="gro"/>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
41 <when input="output_format" value="pdb" format="pdb"/>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
42 </change_format>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
43 </data>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
44 <expand macro="log_outputs" />
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
45 </outputs>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
46 <tests>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
47 <test>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
48 <param name="input_file" value="processed.gro" ftype="gro"/>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
49 <param name="output_format" value="gro" />
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
50 <param name="config" value="true" />
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
51 <param name="dim" value="1.0" />
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
52 <param name="type" value="cubic" />
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
53 <output name="output" file="newbox.gro"/>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
54 </test>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
55 <test>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
56 <param name="input_file" value="newbox.gro" ftype="gro"/>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
57 <param name="output_format" value="pdb" />
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
58 <param name="config" value="false" />
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
59 <output name="output" file="newbox.pdb"/>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
60 </test>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
61 </tests>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
62 <help><![CDATA[
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
63
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
64 .. class:: infomark
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
65
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
66 **What it does**
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
67
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
68 This tool performs the initial setup prior to a GROMACS simulation. This entails producing a topology from an input structure using the pdb2gmx command and also defining a simulation box with editconf.
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
69
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
70 Please note that the tool will only successfully generate a topology for residues it recognizes (i.e. standard amino acids). If the structure contains other components such as ligands, these should be separately parameterized with the AmberTools or ACPYPE tools. In this case, make sure to also use an AMBER forcefield for this tool to ensure compatability with the ligand topology.
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
71
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
72 _____
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
73
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
74 .. class:: infomark
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
75
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
76 **Input**
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
77
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
78 - PDB file.
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
79 - Water model and forcefield must be specified.
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
80 - Parameters for the simulation box (dimensions and shape).
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
81
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
82 _____
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
83
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
84
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
85 .. class:: infomark
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
86
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
87 **Output**
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
88
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
89 - GROMACS topology (TOP) file.
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
90 - Position restraint (itp) file, which may be useful for system equilibration.
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
91 - GRO structure file.
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
92
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
93 ]]></help>
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
94
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
95 <expand macro="citations" />
4ec90cb2fec0 Uploaded
flepiane
parents:
diff changeset
96 </tool>