view cif2cell.xml @ 5:348d3fb1d1f2 draft default tip

planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/cif2cell commit 389608650050596b28bc0c055de9f98c513a6f65
author muon-spectroscopy-computational-project
date Thu, 18 Jul 2024 09:06:52 +0000
parents 0d13d09ff6b1
children
line wrap: on
line source

<tool id="cif2cell" name="cif2cell" version="@TOOL_VERSION@+galaxy@WRAPPER_VERSION@" python_template_version="3.5" profile="22.05" license="MIT">
    <description>convert .cif file to .cell</description>
    <macros>
        <!-- version of underlying tool (PEP 440) -->
        <token name="@TOOL_VERSION@">2.0.0a3</token>
        <!-- version of this tool wrapper (integer) -->
        <token name="@WRAPPER_VERSION@">4</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>
        <requirement type="package" version="2.0.0a3">cif2cell</requirement>
    </requirements>
    <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 $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="Preserve unit cell" help="If set, will not reduce to the primitive cell." />
        <param argument="--vca" type="boolean" truevalue="--vca" falsevalue="" label="Use Virtual Crystal Approximation" help="If set, will set up an alloy using the virtual crystal approximation (VCA). Currently only supported by the CASTEP interface." />
        <param argument="--cartesian" type="boolean" truevalue="--cartesian" falsevalue="" label="Use Cartesian coordinates" help="If set, the program generates outputs in cartesian coordinates." />
    </inputs>
    <outputs>
        <data name="out_cell" format="cell" from_work_dir="out.cell" />
    </outputs>
    <tests>
        <test expect_num_outputs="1">
            <param name="file" value="Si.cif" ftype="cif" />
            <output name="out_cell" file="Si_out.cell" compare="diff" lines_diff="2" ftype="cell" />
        </test>
        <test expect_num_outputs="1">
            <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.

        .. class:: warningmark
            warning

        **WARNING**: ``.cif`` files may contain errors that prevent cif2cell from running properly.
        If you find that you run cif2cell and do not get a satisfactory ``.cell`` file,
        please consider revising the corresponding ``.cif`` file and, if necessary,
        obtaining an alternative ``.cif`` file from a suitable crystalline database.

        cif2cell is distributed under the GPLv3 license. This tool wrapper is distributed under the MIT license.
    ]]></help>
    <citations>
        <citation type="doi">10.1016/j.cpc.2011.01.013</citation>
    </citations>
</tool>