annotate editconf.xml @ 29:9fcc059ba508 draft default tip

Uploaded

<tool id="gmx_editconf_daimoners" name="GROMACS structure configuration daimoners edition"  version="@TOOL_VERSION@+galaxy@GALAXY_VERSION@">
    <description>using editconf</description>
    <macros>
        <token name="@GALAXY_VERSION@">0</token>
        <import>macros.xml</import>
    </macros>

    <expand macro="requirements" />

    <command detect_errors="exit_code"><![CDATA[

        echo "boxtype.boxytype:" $box.boxtype.boxtype >> verbose.txt &&
        
        ln -s '$input_file' ./input.$input_file.ext &&
        gmx editconf
            -f ./input.$input_file.ext
            -o ./output.${output_format}
            #if $box.config == "true":
                #if $box.boxtype.boxtype == "cubic":
                    -box $box.boxtype.cubicdim
                #end if
                #if $box.boxtype.boxtype == "custom":
                    -d $box.boxtype.boxdim
                    -bt $box.boxtype.type
                #end if
            #end if
            &>> verbose.txt &&

        cp ./output.${output_format} '$output'

    ]]></command>

    <inputs>
        <param argument="input_file" type="data" format='gro,pdb' label="Input structure"/>
        <param argument="output_format" type="select" label="Output format">
            <option value="gro">GRO file</option>
            <option value="pdb">PDB file</option>
        </param>

        <conditional name="box">
            <param argument="config" type="select" label="Configure box?">
                <option value="true">Yes</option>
                <option value="false" selected="true">No</option>
            </param>
            <when value="true">
                <conditional name="boxtype">
                    <param argument="boxtype" type="select" label="Box type">
                        <option value="cubic">Standard cubic box</option>
                        <option value="custom">Custom box type</option>
                    </param>

                    <when value="cubic">
                        <param argument="cubicdim" type="float" label="Box dimensions in nanometers" value="0.0" min="0.0" max="1000.0" help="Dimensions of the box in which simulation will take place" />
                    </when>

                    <when value="custom">
                        <param argument="boxdim" type="float" label="Size to be added to the dimensions of the system" value="0.0" min="0.0" max="1000.0" help="Size to be added to the dimension of the system" />
                        <param argument="type" type="select" label="Box type" help="Box type">
                            <option value="cubic">Cubic</option>
                            <option value="triclinic">Triclinic</option>
                            <option value="dodecahedron">Rhombic dodecahedron</option>
                            <option value="octahedron">Truncated octahedron</option>
                        </param>
                    </when>
                </conditional>
            </when>
            <when value="false"/>
        </conditional>
        
    <expand macro="log" />

    </inputs>
    <outputs>
        <data name="output" format="gro">
            <change_format>
                <when input="output_format" value="gro" format="gro"/>
                <when input="output_format" value="pdb" format="pdb"/>
            </change_format>
        </data>
        <expand macro="log_outputs" />
    </outputs>
    <tests>
        <test>
            <param name="input_file" value="processed.gro" ftype="gro"/>
            <param name="output_format" value="gro" />
            <param name="config" value="true" />
            <param name="dim" value="1.0" />
            <param name="type" value="cubic" />
            <output name="output" file="newbox.gro"/>
        </test>
        <test>
            <param name="input_file" value="newbox.gro" ftype="gro"/>
            <param name="output_format" value="pdb" />
            <param name="config" value="false" />
            <output name="output" file="newbox.pdb"/>
        </test>
    </tests>
    <help><![CDATA[

.. class:: infomark

**What it does**

This tool performs the initial setup prior to a GROMACS simulation. This entails producing a topology from an input structure using the pdb2gmx command and also defining a simulation box with editconf.

Please note that the tool will only successfully generate a topology for residues it recognizes (i.e. standard amino acids). If the structure contains other components such as ligands, these should be separately parameterized with the AmberTools or ACPYPE tools. In this case, make sure to also use an AMBER forcefield for this tool to ensure compatability with the ligand topology. 

_____

.. class:: infomark

**Input**

       - PDB file.
       - Water model and forcefield must be specified.
       - Parameters for the simulation box (dimensions and shape).
     
_____

        
.. class:: infomark

**Output**

       - GROMACS topology (TOP) file.
       - Position restraint (itp) file, which may be useful for system equilibration.
       - GRO structure file.

    ]]></help>

    <expand macro="citations" />
</tool>