annotate restraints.xml @ 3:f79f4671eaf2 draft

"planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit 03127e495a0a1a022928c1a03527974c9e81b5a1"
author chemteam
date Tue, 21 Jan 2020 07:28:02 -0500
parents 72c2b7992c26
children ca6a4740114e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
1 <tool id="gmx_restraints" name="Create GROMACS position restraints files" version="@VERSION@">
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
2 <description>using genrestr</description>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
3 <macros>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
4 <import>macros.xml</import>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
5 </macros>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
6
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
7 <expand macro="requirements" />
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
8
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
10
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
11 ln -s '$gro_input' ./gro_input.gro &&
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
12 ln -s '$ndx_input' ./ndx_input.ndx &&
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
13 echo '$index' | gmx genrestr -f ./gro_input.gro -n ./ndx_input.ndx -o posre.itp -fc $fc &>> verbose.txt
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
14
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
15 ]]></command>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
16
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
17 <inputs>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
18 <param argument="gro_input" type="data" format='gro' label="GRO input file" help="Input structure"/>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
19 <param argument="ndx_input" type="data" format='ndx' label="Index (NDX) file" help="Index file containing the atoms which should be restrained"/>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
20 <param argument="fc" type="text" value="1000 1000 1000" label="Force constants" help="Vector (in Cartesian space) specifying force constants for the restraints (kJ/mol nm^2)">
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
21 <validator type="regex" message="Only numeric values and whitespace allowed">^[0-9 ]*$</validator>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
22 </param>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
23 <param argument="index" type="text" label="Index of group" help="Index of group for calculating position restraints - i.e. the group's position in the ndx file (using zero-based numbering, so the first group has index 0).">
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
24 <validator type="regex" message="Only numeric values allowed">^[0-9]*$</validator>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
25 </param>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
26
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
27 <expand macro="log" />
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
28
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
29 </inputs>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
30 <outputs>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
31 <data name="output1" format="itp" from_work_dir="posre.itp"/>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
32 <expand macro="log_outputs" />
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
33 </outputs>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
34 <tests>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
35 <test>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
36 <param name="gro_input" value="md_0_1.gro" />
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
37 <param name="ndx_input" value="md_0_1.ndx" />
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
38 <param name="fc" value="500 600 700" />
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
39 <param name="index" value="16" />
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
40 <output name="output1" file="posre_cl.itp" ftype="itp"/>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
41 </test>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
42 </tests>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
43 <help><![CDATA[
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
44
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
45 .. class:: infomark
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
46
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
47 **What it does**
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
48
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
49 This tool calculates a position restraint (ITP) file for part of a system, specified in provided GRO and NDX files.
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
50
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
51 _____
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
52
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
53 .. class:: infomark
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
54
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
55 **Input**
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
56
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
57 - GRO structure file.
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
58 - Index (NDX) file.
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
59 - Force constant vector (in Cartesian space) for applying restraints. E.g. '1000 1000 1000' will apply a force constraint of 1000 kJ/mol nm^2 along each (XYZ) axis.
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
60 - Index number of the group for which restraints should be calculated, i.e. the position of the group in the index file.
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
61
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
62 _____
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
63
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
64
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
65 .. class:: infomark
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
66
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
67 **Output**
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
68
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
69 - Position restraint (itp) file, which may be useful for system equilibration.
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
70
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
71 ]]></help>
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
72
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
73 <expand macro="citations" />
72c2b7992c26 "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/gromacs commit a71d03531d57b87b5e3ce40ee7d974fbe53a1dfa"
chemteam
parents:
diff changeset
74 </tool>