Mercurial > repos > muon-spectroscopy-computational-project > cif2cell
annotate cif2cell.xml @ 3:e5f1ac42b063 draft
planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 70a4d37ecdf5d586703cfc509922311e95d3205c
| author | muon-spectroscopy-computational-project |
|---|---|
| date | Tue, 18 Jul 2023 13:25:43 +0000 |
| parents | 60ad7a4f1faf |
| children | 0d13d09ff6b1 |
| 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) --> |
|
3
e5f1ac42b063
planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents:
2
diff
changeset
|
7 <token name="@WRAPPER_VERSION@">2</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"/> |
|
3
e5f1ac42b063
planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents:
2
diff
changeset
|
12 <person givenName="Patrick" familyName="Austin" url="https://github.com/patrick-austin" identifier="https://orcid.org/0000-0002-6279-7823"/> |
|
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
|
13 <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
|
14 </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
|
15 <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
|
16 <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
|
17 </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
|
18 <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
|
19 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
|
20 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
|
21 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
|
22 ]]></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
|
23 <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
|
24 <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
|
25 </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
|
26 <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
|
27 <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
|
28 </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
|
29 <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
|
30 <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
|
31 <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
|
32 <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
|
33 </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
|
34 <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
|
35 <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
|
36 <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
|
37 </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
|
38 </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
|
39 <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
|
40 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
|
41 |
|
3
e5f1ac42b063
planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents:
2
diff
changeset
|
42 Given an input ``.cif`` structure file, convert to an equivalent ``.cell`` |
|
e5f1ac42b063
planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents:
2
diff
changeset
|
43 structure file for use with electronic structure program CASTEP. |
|
e5f1ac42b063
planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents:
2
diff
changeset
|
44 |
|
e5f1ac42b063
planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents:
2
diff
changeset
|
45 .. class:: warningmark |
|
e5f1ac42b063
planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents:
2
diff
changeset
|
46 warning |
|
e5f1ac42b063
planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents:
2
diff
changeset
|
47 |
|
e5f1ac42b063
planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents:
2
diff
changeset
|
48 **WARNING**: ``.cif`` files may contain errors that prevent cif2cell from running properly. |
|
e5f1ac42b063
planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents:
2
diff
changeset
|
49 If you find that you run cif2cell and do not get a satisfactory ``.cell`` file, |
|
e5f1ac42b063
planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents:
2
diff
changeset
|
50 please consider revising the corresponding ``.cif`` file and, if necessary, |
|
e5f1ac42b063
planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents:
2
diff
changeset
|
51 obtaining an alternative ``.cif`` file from a suitable crystalline database. |
|
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
|
52 |
|
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
|
53 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
|
54 ]]></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
|
55 <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
|
56 <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
|
57 </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
|
58 </tool> |