VOX-FE
======

``VOX-FE`` can be loaded using the following command:

.. code-block:: console

    $ module load module load {MOD_VOXFE}


An example job script can be found here. This script described using a whole node with 96 cores exclusively for two hours. Remember to update the account code and email address provided to ``slurm`` to your own details and be sure to substitute ``Script.txt`` with the path to your script.

.. code-block:: bash

    {SHEBANG}
    #SBATCH --job-name=VOX-FE_CPU_example       # Job name
    #SBATCH --mail-type=BEGIN,END,FAIL          # Mail events (NONE, BEGIN, END, FAIL, ALL)
    #SBATCH --mail-user=abc123@york.ac.uk       # Where to send mail to
    #SBATCH --nodes=1                           # Number of nodes
    #SBATCH --exclusive                         # Exclusively use the whole node
    #SBATCH --time=02:00:00                     # Time of the job in HH:MM:SS
    #SBATCH --output=VOX-FE_CPU_example-%j.log  # Output file
    #SBATCH --account=dept-proj-year            # Project account to use

    # Abort if any command fails
    set -e

    module purge                                # purge any loaded modules
    module load OpenMPI/3.1.4-GCC-8.3.0
    module load {MOD_VOXFE}

    echo "Running small-vox-fe on $SLURM_JOB_CPUS_PER_NODE CPU cores"
    echo "Nodes allocated to job: " $SLURM_JOB_NUM_NODES "(" $SLURM_JOB_NODELIST ")"
    echo

    date
    mpirun -np $SLURM_JOB_CPUS_PER_NODE PARA_BMU Script.txt
    date

.. note::

    ``VOX-FE`` can not take advantage of a GPU, and runs purely on a CPU