annotate minim.xml @ 1:c34986976856 draft default tip

Uploaded
author fmercuri
date Mon, 28 Jun 2021 08:59:17 +0000
parents c581846ec2cb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
1 <tool id="gmx_em" name="GROMACS energy minimization daimoners' version" version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@">
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
2 <description>of the system prior to equilibration and production MD</description>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
3 <macros>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
4 <import>macros.xml</import>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
5 <token name="@GALAXY_VERSION@">0</token>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
6 </macros>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
7
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
8 <expand macro="requirements" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
9
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
11
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
12 #if $mdp.mdpfile == 'custom':
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
13 ln -s '$mdp.mdp_input' ./minim.mdp &&
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
14 #else:
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
15 ln -s '$minim' ./minim.mdp &&
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
16 #end if
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
17
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
18 ln -s '$gro_input' ./solv_ions.gro &&
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
19 ln -s '$top_input' ./top_input.top &&
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
20
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
21 gmx grompp -f ./minim.mdp -c ./solv_ions.gro -r ./solv_ions.gro -p ./top_input.top -o em.tpr -maxwarn 5 &>> verbose.txt &&
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
22 gmx mdrun -nt "\${GALAXY_SLOTS:-4}" -deffnm em &>> verbose.txt
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
23
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
24 ]]></command>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
25 <configfiles>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
26 <!-- .mdp files for the gromacs simulation -->
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
27 <configfile name="minim">
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
28 #if $mdp.mdpfile == 'default':
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
29 ; minim.mdp - used as input into grompp to generate em.tpr
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
30 integrator = $mdp.integrator ; Algorithm (steep = steepest descent minimization)
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
31 emtol = $mdp.emtol ; Stop minimization when the maximum force is less than this value
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
32 emstep = $mdp.emstep ; Energy step size
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
33 nsteps = $mdp.md_steps ; Maximum number of (minimization) steps to perform
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
34
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
35 ; Parameters describing how to find the neighbors of each atom and how to calculate the interactions
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
36 nstlist = 1 ; Frequency to update the neighbor list and long range forces
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
37 cutoff-scheme = $mdp.cutoffscheme
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
38 ns_type = grid ; Method to determine neighbor list (simple, grid)
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
39 coulombtype = $mdp.coulombtype ; Treatment of long range electrostatic interactions
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
40 rcoulomb = $mdp.rcoulomb ; Short-range electrostatic cut-off
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
41 rlist = $mdp.rlist ; Cut-off distance for the short-range neighbor list.
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
42 rvdw = $mdp.rvdw ; Short-range Van der Waals cut-off
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
43 pbc = xyz ; Periodic Boundary Conditions (yes/no)
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
44 #end if
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
45 </configfile>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
46 </configfiles>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
47
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
48 <inputs>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
49 <param argument="gro_input" type="data" format='gro' label="GRO structure file."/>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
50 <param argument="top_input" type="data" format='top' label="Topology (TOP) file."/>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
51 <conditional name="mdp">
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
52 <param name="mdpfile" type="select" label="Parameter input">
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
53 <option value="custom">Upload own MDP file</option>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
54 <option value="default">Use default (partially customisable) setting</option>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
55 </param>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
56 <when value="custom">
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
57 <param argument="mdp_input" type="data" format='mdp' label="MD parameters (MDP) file (optional; default settings if not set)."/>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
58 </when>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
59
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
60 <when value="default">
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
61 <param argument="integrator" type="select" label="Choice of integrator.">
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
62 <option value="steep">Steepest descent algorithm.</option>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
63 <option value="cg">Conjugate gradient algorithm.</option>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
64 <option value="l-bfgs">Quasi-Newtonian algorithm.</option>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
65 </param>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
66 <param argument="cutoffscheme" type="select" label="Neighbor searching.">
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
67 <option value="Verlet">Generate a pair list with buffering.</option>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
68 <option value="group">Generate a pair list for groups of atoms.</option>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
69 </param>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
70 <param argument="coulombtype" type="select" label="Electrostatics.">
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
71 <option value="PME">Fast smooth Particle-Mesh Ewald (SPME) electrostatics.</option>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
72 <option value="P3M-AD">Particle-Particle Particle-Mesh algorithm with analytical derivative.</option>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
73 <option value="Reaction-Field-zero">Reaction field electrostatics.</option>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
74 </param>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
75 <param argument="rcoulomb" value="1.0" type="float" label="Distance for the Coulomb cut-off."/>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
76 <param argument="rlist" value="1.0" type="float" label="Cut-off distance for the short-range neighbor list. Ignored if the Verlet cutoff scheme is set."/>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
77 <param argument="rvdw" value="1.0" type="float" label="Short range van der Waals cutoff."/>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
78 <param argument="md_steps" type="integer" label="Number of steps for the MD simulation" value="0" min="0" max="1000000" help="MD steps" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
79 <param argument="emtol" type="float" label="EM tolerance" value="0" min="0" max="10000" help="The minimization is converged when the maximum force is smaller than this value" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
80 <param argument="emstep" type="float" label="Maximum step size /nm" value="0.01" min="0.0001" max="1.0" help="Initial step size in nm." />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
81 </when>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
82 </conditional>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
83 <expand macro="log" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
84 </inputs>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
85 <outputs>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
86 <data name="output1" format="gro" from_work_dir="em.gro"/>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
87 <data name="output2" format="edr" from_work_dir="em.edr"/>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
88 <expand macro="log_outputs" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
89 </outputs>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
90 <tests>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
91 <test>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
92 <param name="gro_input" value="str_ions.gro" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
93 <param name="top_input" value="topol_solv.top" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
94 <param name="mdpfile" value="default" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
95 <param name="integrator" value="steep" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
96 <param name="cutoffscheme" value="Verlet" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
97 <param name="coulombtype" value="PME" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
98 <param name="rcoulomb" value="1.0" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
99 <param name="rlist" value="1.0" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
100 <param name="md_steps" value="50000" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
101 <param name="emtol" value="1000.0" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
102 <param name="emstep" value="0.01" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
103 <output name="output1" ftype="gro" >
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
104 <assert_contents>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
105 <has_size value="4281" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
106 </assert_contents>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
107 </output>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
108 <output name="output2" ftype="edr" >
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
109 <assert_contents>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
110 <!-- this binary can vary in size a lot unfortunately -->
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
111 <has_size value="5000" delta="1000" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
112 </assert_contents>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
113 </output>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
114 </test>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
115 <test>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
116 <param name="gro_input" value="str_ions.gro" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
117 <param name="top_input" value="topol_solv.top" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
118 <param name="mdpfile" value="custom" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
119 <param name="mdp_input" value="minim.mdp" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
120 <output name="output1" ftype="gro" >
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
121 <assert_contents>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
122 <has_size value="4281" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
123 </assert_contents>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
124 </output>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
125 <output name="output2" ftype="edr" >
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
126 <assert_contents>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
127 <!-- this binary can vary in size a lot unfortunately -->
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
128 <has_size value="5000" delta="1000" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
129 </assert_contents>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
130 </output>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
131 </test>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
132
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
133 </tests>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
134 <help><![CDATA[
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
135
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
136 .. class:: infomark
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
137
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
138 **What it does**
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
139
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
140 This tool performs energy minimization of a system prior to a GROMACS simulation.
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
141
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
142 _____
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
143
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
144 .. class:: infomark
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
145
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
146 **Input**
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
147
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
148 - GRO structure file.
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
149 - Topology (TOP) file.
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
150 - MDP parameter file (optional)
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
151
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
152 To take advantage of all GROMACS features, upload an MDP file with simulation parameters. Otherwise, choose parameters through the Galaxy interface. See the `manual`_ for more information on the options.
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
153
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
154 .. _`manual`: http://manual.gromacs.org/documentation/2018/user-guide/mdp-options.html
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
155
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
156 _____
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
157
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
158
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
159 .. class:: infomark
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
160
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
161 **Output**
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
162
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
163 - GRO structure file.
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
164
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
165 ]]></help>
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
166
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
167 <expand macro="citations" />
c581846ec2cb Uploaded
fmercuri
parents:
diff changeset
168 </tool>