annotate md_slicer.xml @ 8:730ef07b90ae draft

"planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
author chemteam
date Thu, 24 Jun 2021 21:09:24 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
1 <tool id="md_slicer" name="Slice MD trajectories" version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@">
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
2 <description>using the MDTraj package</description>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
3 <macros>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
4 <token name="@TOOL_VERSION@">1.9.6</token>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
5 <token name="@GALAXY_VERSION@">0</token>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
6 </macros>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
7 <requirements>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
8 <requirement type="package" version="@TOOL_VERSION@">mdtraj</requirement>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
9 </requirements>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
11 ln -s '$traj' traj.${traj.ext} &&
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
12 mdconvert traj.${traj.ext} -o output.${traj.ext} -i $start:$end:$stride &&
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
13 mv output.${traj.ext} '$output'
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
14 ]]></command>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
15 <inputs>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
16 <param argument="traj" type="data" format='xtc,dcd' label="Input trajectory file for slicing"/>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
17 <param argument="start" type="integer" value="0" label="Start frame for slicing"/>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
18 <param argument="end" type="integer" value="10000" label="End frame for slicing"/>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
19 <param argument="stride" type="integer" value="1" label="Stride" help="i.e. load every nth frame from the input file"/>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
20 </inputs>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
21 <outputs>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
22 <data name="output" format_source="traj"/>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
23 </outputs>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
24 <tests>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
25 <test>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
26 <param name="traj" value="traj.xtc" />
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
27 <param name="start" value="0" />
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
28 <param name="end" value="8" />
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
29 <param name="stride" value="2" />
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
30 <output name="output" file="traj_slice.xtc" />
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
31 </test>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
32 <test>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
33 <param name="traj" value="traj.dcd" />
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
34 <param name="start" value="1" />
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
35 <param name="end" value="6" />
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
36 <param name="stride" value="1" />
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
37 <output name="output" file="traj_slice.dcd" compare="sim_size"/>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
38 </test>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
39 </tests>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
40 <help><![CDATA[
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
41 **What it does**
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
42
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
43 This tool extracts a segment from a molecular dynamcics trajectory (i.e. performs a slice).
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
44
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
45 _____
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
46
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
47
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
48 .. class:: infomark
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
49
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
50 **Input**
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
51
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
52 - Trajectory file (xtc, dcd)
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
53
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
54 In addition, a start frame and end frame have to be specified for the output trajectory,
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
55 as well as a value for the 'stride' (to save only every nth frame in the output file).
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
56 _____
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
57
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
58
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
59 .. class:: infomark
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
60
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
61 **Output**
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
62
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
63 - Trajectory file (xtc, dcd) extracted from the input file.
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
64 ]]></help>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
65 <citations>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
66 <citation type="doi">10.1016/j.bpj.2015.08.015</citation>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
67 </citations>
730ef07b90ae "planemo upload for repository https://github.com/galaxycomputationalchemistry/galaxy-tools-compchem/tools/mdslicer commit 4ea801b442afefb53273fb8854024358ea1dbdae"
chemteam
parents:
diff changeset
68 </tool>