annotate pm_symmetry.xml @ 4:34c550d15bd4 draft default tip

planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 389608650050596b28bc0c055de9f98c513a6f65
author muon-spectroscopy-computational-project
date Fri, 26 Jul 2024 12:57:53 +0000
parents c062cefbb20f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
c062cefbb20f planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents: 2
diff changeset
1 <tool id="pm_symmetry" name="PyMuonSuite Symmetry" version="@PYMUONSUITE_VERSION@+galaxy@WRAPPER_VERSION@" python_template_version="3.5" profile="22.05" license="MIT">
0
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
2 <description>generate Wyckoff points symmetry report</description>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
3 <macros>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
4 <!-- version of this tool wrapper (integer) -->
4
34c550d15bd4 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 389608650050596b28bc0c055de9f98c513a6f65
muon-spectroscopy-computational-project
parents: 3
diff changeset
5 <token name="@WRAPPER_VERSION@">1</token>
3
c062cefbb20f planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents: 2
diff changeset
6 <import>muon_macros.xml</import>
0
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
7 </macros>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
8 <creator>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
9 <person givenName="Jyothish" familyName="Thomas" identifier="https://orcid.org/0000-0003-4724-6924"/>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
10 <person givenName="Eli" familyName="Chadwick" url="https://github.com/elichad" identifier="https://orcid.org/0000-0002-0035-6475"/>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
11 <organization url="https://muon-spectroscopy-computational-project.github.io/index.html" name="The Muon Spectroscopy Computational Project"/>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
12 </creator>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
13 <requirements>
3
c062cefbb20f planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents: 2
diff changeset
14 <requirement type="package" version="@PYMUONSUITE_VERSION@">pymuonsuite</requirement>
0
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
15 </requirements>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
16 <command detect_errors="exit_code"><![CDATA[
2
620ab6826b9b planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
17 structure_name_internal=\$(sed 's/ /\_/g' <<< '$structure.name') &&
620ab6826b9b planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
18 ln -s '$structure' \$structure_name_internal &&
0
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
19 pm-symmetry \$structure_name_internal > out.txt
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
20 ]]></command>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
21 <inputs>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
22 <param type="data" name="structure" label="Structure file" format="cell,cif,xyz,extxyz" help="The structure to calculate symmetries of. Accepted file types: cell."/>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
23 </inputs>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
24 <outputs>
4
34c550d15bd4 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 389608650050596b28bc0c055de9f98c513a6f65
muon-spectroscopy-computational-project
parents: 3
diff changeset
25 <data name="symmetry_report" format="txt" from_work_dir="out.txt"/>
0
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
26 </outputs>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
27 <tests>
1
d8146a73b011 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 6a07c4caed5ef35f35198d54ebafd7d1d6d60edb
muon-spectroscopy-computational-project
parents: 0
diff changeset
28 <test expect_num_outputs="1">
0
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
29 <param name="structure" value="Si.cell" ftype="cell"/>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
30 <output name="symmetry_report" file="test_out.txt" ftype="txt" compare="re_match_multiline"/>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
31 </test>
1
d8146a73b011 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 6a07c4caed5ef35f35198d54ebafd7d1d6d60edb
muon-spectroscopy-computational-project
parents: 0
diff changeset
32 <test expect_num_outputs="1">
0
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
33 <param name="structure" value="Si.cif" ftype="cif"/>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
34 <output name="symmetry_report" file="test_out.txt" ftype="txt" compare="re_match_multiline"/>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
35 </test>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
36 <test expect_failure="true">
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
37 <param name="structure" value="Si.xyz" ftype="xyz"/>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
38 <assert_stderr>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
39 <has_text text="TypeError: 'NoneType' object is not subscriptable"/>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
40 </assert_stderr>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
41 </test>
1
d8146a73b011 planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 6a07c4caed5ef35f35198d54ebafd7d1d6d60edb
muon-spectroscopy-computational-project
parents: 0
diff changeset
42 <test expect_num_outputs="1">
0
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
43 <param name="structure" value="Si.extxyz" ftype="extxyz"/>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
44 <output name="symmetry_report" file="test_out.txt" ftype="txt" compare="re_match_multiline"/>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
45 </test>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
46 </tests>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
47 <help><![CDATA[
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
48 usage: pm-symmetry structure
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
49
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
50 Given an input structure, generates a Wyckoff points symmetry report for that structure.
2
620ab6826b9b planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
51
620ab6826b9b planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
52 PyMuonSuite is distributed under the GPLv3 license. This tool wrapper is distributed under the MIT license.
0
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
53 ]]></help>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
54 <citations>
3
c062cefbb20f planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 70a4d37ecdf5d586703cfc509922311e95d3205c
muon-spectroscopy-computational-project
parents: 2
diff changeset
55 <citation type="doi">@PYMUONSUITE_CITATION@</citation>
2
620ab6826b9b planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit 4f06b404d8b7fb83995f3052faa7e2ec7811f507
muon-spectroscopy-computational-project
parents: 1
diff changeset
56 <citation type="doi">10.1063/5.0012381</citation>
0
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
57 </citations>
39d7644724dc planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/pm_symmetry commit d130cf2c46d933fa9d0214ddbd5ddf860f322dc4
muon-spectroscopy-computational-project
parents:
diff changeset
58 </tool>