diff cif2cell.xml @ 4:0d13d09ff6b1 draft

planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit bb4b06ffc1264bd7cf5ffcfa855732768eea5a10
author muon-spectroscopy-computational-project
date Fri, 01 Dec 2023 11:17:36 +0000
parents e5f1ac42b063
children 348d3fb1d1f2
line wrap: on
line diff
--- a/cif2cell.xml	Tue Jul 18 13:25:43 2023 +0000
+++ b/cif2cell.xml	Fri Dec 01 11:17:36 2023 +0000
@@ -4,12 +4,13 @@
         <!-- version of underlying tool (PEP 440) -->
         <token name="@TOOL_VERSION@">2.0.0a3</token>
         <!-- version of this tool wrapper (integer) -->
-        <token name="@WRAPPER_VERSION@">2</token>
+        <token name="@WRAPPER_VERSION@">3</token>
     </macros>
     <creator>
         <person givenName="Anish" familyName="Mudaraddi" identifier="https://orcid.org/0000-0002-2135-2705"/>
         <person givenName="Eli" familyName="Chadwick" url="https://github.com/elichad" identifier="https://orcid.org/0000-0002-0035-6475"/>
         <person givenName="Patrick" familyName="Austin" url="https://github.com/patrick-austin" identifier="https://orcid.org/0000-0002-6279-7823"/>
+        <person givenName="Maitrayee" familyName="Singh" url="https://github.com/MyTreeSings"/>
         <organization url="https://muon-spectroscopy-computational-project.github.io/index.html" name="The Muon Spectroscopy Computational Project"/>
     </creator>
     <requirements>
@@ -18,10 +19,13 @@
     <command detect_errors="exit_code"><![CDATA[
         file_name=\$(sed 's/ //g' <<< '$file.name') &&
         ln -s '$file' \$file_name &&
-        cif2cell -f \$file_name -p castep -o out.cell
+        cif2cell -f \$file_name -p castep -o out.cell $no_reduce $vca $cartesian
     ]]></command>
     <inputs>
         <param type="data" argument="--file" format="cif" label="Structure file to Convert (.cif)" />
+        <param argument="--no-reduce" type="boolean" truevalue="--no-reduce" falsevalue="" label="Do you want to construct a primitive cell using --no-reduce?" help="Use a cif file to convert into a structural (cell) file." />
+        <param argument="--vca" type="boolean" truevalue="--vca" falsevalue="" label="Do you want to set up an alloy using Virtual Crystal Approximation?" help="Use a cif file to convert into a structural (cell) file." />
+        <param argument="--cartesian" type="boolean" truevalue="--cartesian" falsevalue="" label="Do you want to generate any output in cartesian coordinates?" help="Use a cif file to convert into a structural (cell) file." />
     </inputs>
     <outputs>
         <data label="Conversion of $file.name to .cell" name="out_cell" format="cell" from_work_dir="out.cell" />
@@ -35,10 +39,31 @@
             <param name="file" value="diamond.cif" ftype="cif" />
             <output name="out_cell" file="diamond_out.cell" compare="diff" lines_diff="2" ftype="cell" />
         </test>
+        <test expect_num_outputs="1">
+            <param name="file" value="Si.cif" ftype="cif" />
+            <param name="no_reduce" value="--no-reduce" />
+            <output name="out_cell" file="Si_no_reduce_out.cell" compare="diff" lines_diff="2" ftype="cell" />
+        </test>
+        <test expect_num_outputs="1">
+            <param name="file" value="Si.cif" ftype="cif" />
+            <param name="vca" value="--vca" />
+            <output name="out_cell" file="Si_vca_out.cell" compare="diff" lines_diff="2" ftype="cell" />
+        </test>
+        <test expect_num_outputs="1">
+            <param name="file" value="Si.cif" ftype="cif" />
+            <param name="cartesian" value="--cartesian" />
+            <output name="out_cell" file="Si_cartesian_out.cell" compare="diff" lines_diff="2" ftype="cell" />
+        </test>
     </tests>
     <help><![CDATA[
         usage: cif2cell -f file.cif -p castep -o file.cell
+        
+        Do not reduce to primitve cell: cif2cell -f file.cif -p castep -o file.cell --no-reduce
 
+        Set up an alloy using virtual crystal approximation: cif2cell -f file.cif -p castep -o file.cell --vca
+
+        Make the program generate any output in cartesian coordinates: cif2cell -f file.cif -p castep -o file.cell --cartesian
+        
         Given an input ``.cif`` structure file, convert to an equivalent ``.cell``
         structure file for use with electronic structure program CASTEP.
 
@@ -55,4 +80,4 @@
     <citations>
         <citation type="doi">10.1016/j.cpc.2011.01.013</citation>
     </citations>
-</tool>
\ No newline at end of file
+</tool>