annotate cif2cell.xml @ 2:60ad7a4f1faf draft

planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
author muon-spectroscopy-computational-project
date Fri, 03 Feb 2023 15:38:50 +0000
parents a2583fac03ab
children e5f1ac42b063
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
60ad7a4f1faf planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
1 <tool id="cif2cell" name="cif2cell" version="@TOOL_VERSION@+galaxy@WRAPPER_VERSION@" python_template_version="3.5" profile="22.05" license="MIT">
0
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
2 <description>convert .cif file to .cell</description>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
3 <macros>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
4 <!-- version of underlying tool (PEP 440) -->
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
5 <token name="@TOOL_VERSION@">2.0.0a3</token>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
6 <!-- version of this tool wrapper (integer) -->
2
60ad7a4f1faf planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
7 <token name="@WRAPPER_VERSION@">1</token>
0
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
8 </macros>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
9 <creator>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
10 <person givenName="Anish" familyName="Mudaraddi" identifier="https://orcid.org/0000-0002-2135-2705"/>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
11 <person givenName="Eli" familyName="Chadwick" url="https://github.com/elichad" identifier="https://orcid.org/0000-0002-0035-6475"/>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
12 <organization url="https://muon-spectroscopy-computational-project.github.io/index.html" name="The Muon Spectroscopy Computational Project"/>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
13 </creator>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
14 <requirements>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
15 <requirement type="package" version="2.0.0a3">cif2cell</requirement>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
16 </requirements>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
17 <command detect_errors="exit_code"><![CDATA[
2
60ad7a4f1faf planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
18 file_name=\$(sed 's/ //g' <<< '$file.name') &&
60ad7a4f1faf planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
19 ln -s '$file' \$file_name &&
60ad7a4f1faf planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
20 cif2cell -f \$file_name -p castep -o out.cell
0
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
21 ]]></command>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
22 <inputs>
2
60ad7a4f1faf planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
23 <param type="data" argument="--file" format="cif" label="Structure file to Convert (.cif)" />
0
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
24 </inputs>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
25 <outputs>
2
60ad7a4f1faf planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
26 <data label="Conversion of $file.name to .cell" name="out_cell" format="cell" from_work_dir="out.cell" />
0
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
27 </outputs>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
28 <tests>
1
a2583fac03ab planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 6a07c4caed5ef35f35198d54ebafd7d1d6d60edb
muon-spectroscopy-computational-project
parents: 0
diff changeset
29 <test expect_num_outputs="1">
2
60ad7a4f1faf planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
30 <param name="file" value="Si.cif" ftype="cif" />
0
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
31 <output name="out_cell" file="Si_out.cell" compare="diff" lines_diff="2" ftype="cell" />
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
32 </test>
1
a2583fac03ab planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 6a07c4caed5ef35f35198d54ebafd7d1d6d60edb
muon-spectroscopy-computational-project
parents: 0
diff changeset
33 <test expect_num_outputs="1">
2
60ad7a4f1faf planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
34 <param name="file" value="diamond.cif" ftype="cif" />
0
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
35 <output name="out_cell" file="diamond_out.cell" compare="diff" lines_diff="2" ftype="cell" />
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
36 </test>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
37 </tests>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
38 <help><![CDATA[
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
39 usage: cif2cell -f file.cif -p castep -o file.cell
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
40
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
41 Given an input .cif structure file, convert to equivalent .cell structure file.
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
42 Uses electronic structure program 'castep'
2
60ad7a4f1faf planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
43
60ad7a4f1faf planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
44 cif2cell is distributed under the GPLv3 license. This tool wrapper is distributed under the MIT license.
0
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
45 ]]></help>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
46 <citations>
2
60ad7a4f1faf planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
47 <citation type="doi">10.1016/j.cpc.2011.01.013</citation>
0
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
48 </citations>
53df1118d404 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
49 </tool>