annotate muon_macros.xml @ 3:e002cee8f707 draft

planemo upload for repository https://github.com/muon-spectroscopy-computational-project/muon-galaxy-tools/main/muspinsim commit 70a4d37ecdf5d586703cfc509922311e95d3205c

<macros>
    <xml name="dftb_set">
        <param type="select" name="dftb_set" value="3ob-3-1" display="radio" label="DFTB parameter set" help="The parameter set to use for DFTB+. Currently supported are: 3ob-3-1 and pbc-0-3. See help section at the bottom of the page for details.">
            <option value="3ob-3-1">3ob-3-1</option>
            <option value="pbc-0-3">pbc-0-3</option>
        </param>
    </xml>
    <xml name="dftb+">
        <expand macro="dftb_set"/>
        <param type="boolean" name="dftb_pbc" label="Use periodic boundary conditions" help="Whether to turn on periodic boundary conditions in DFTB+." checked="true"/>
    </xml>
    <xml name="dftb_optionals">
        <param type="text" argument="dftb_optionals" value="[]" optional="true" label="DFTB optional files" help="Additional optional json files to activate for DFTBArgs (for example, dftd3.json will use DFTD3 dispersion forces for 3ob-3-1 if DFTB+ has been compiled to support them)."/>
    </xml>
    <xml name="k_points_grid">
        <param type="text" argument="k_points_grid" value="[1,1,1]" label="K-points grid" help="List of three integer k-points. Default is [1,1,1].">
            <validator type="regex" message="Input should only contain whitespace, '[', ']', ',' and digits.">^[\s\d,\[\]]+$</validator>
        </param>
    </xml>
    <!-- version of underlying tool (PEP 440) -->
    <!-- citation should be updated with every underlying tool version -->
    <!-- concept is not updated, and should only be used for referencing the idea of the software -->
    <token name="@MUSPINSIM_VERSION@">2.2.1</token>
    <token name="@MUSPINSIM_CITATION@">10.5281/zenodo.7733979</token>
    <token name="@MUSPINSIM_CONCEPT@">10.5281/zenodo.6517626</token>
    <token name="@PYMUONSUITE_VERSION@">0.3.0</token>
    <token name="@PYMUONSUITE_CITATION@">10.5281/zenodo.8026711</token>
    <token name="@PYMUONSUITE_CONCEPT@">10.5281/zenodo.7025643</token>
</macros>