Software Example

Software Example is a cross-platform (Windows, Linux, MacOS X, etc.) command line utility that can convert various formats of computer audio files in to other formats. It can also apply various effects to these sound files, and, as an added bonus, Software Example can play and record audio files on most platforms.

Interactive Usage

delete as appopriate

After connecting to Stanage (see Establishing a SSH connection), start an interactive session with the following command:

srun --pty bash -i

After connecting to Bessemer (see Establishing a SSH connection), start an interactive session with the srun --pty bash -i command.

The latest version of Software Example (currently version 14.4.2) is made available with the command:

$ module load SoX/14.4.2-GCC-8.3.0

After this the Software Example command can be run from the terminal prompt with the sox command.

Further documentation on the usage of Software Example can be found at the following link: http://sox.sourceforge.net/Docs/Documentation

Batch Usage

The following is an example batch job:

#!/bin/bash
#SBATCH --nodes=1
#SBATCH --ntasks-per-node=4
#SBATCH --mem=8000
#SBATCH --job-name=jobname
#SBATCH --output=output
#SBATCH --time=01:00:00
#SBATCH --mail-user=a.person@sheffield.ac.uk
#SBATCH --mail-type=ALL

module load someModule/version
srun --export=ALL softwarename

Installation notes

Installation method

This section is primarily for administrators of the system. Software Example has been installed using the default Easybuild config files.

Build logs and test reports can be found in $EBDEVELSOFTWARENAME with a given module loaded.

Testing method

Testing has been conducted by ………

The Markup

The above example was rendered with the following markup:

.. _software_stanage:
.. |softwarename| replace:: Software Example
.. |currentver| replace:: 14.4.2
.. |ebtoolchain| replace:: foss-2019b

|softwarename|
==========================================================================================================

.. sidebar:: |softwarename|

   :Versions:  |currentver|
   :Dependencies: |ebtoolchain| toolchain (see Easybuild for details.)
   :URL: http://sox.sourceforge.net/

|softwarename| is a cross-platform (Windows, Linux, MacOS X, etc.) command line utility that can convert various
formats of computer audio files in to other formats. It can also apply various effects to these sound files, and,
as an added bonus, |softwarename| can play and record audio files on most platforms.

========

Interactive Usage
-----------------

*delete as appopriate*

.. include:: /referenceinfo/imports/scheduler/SLURM/common_commands/srun_start_interactive_session_import_stanage.rst
.. include:: /referenceinfo/imports/scheduler/SLURM/common_commands/srun_start_interactive_session_import.rst

The latest version of |softwarename| (currently version |currentver|) is made available with the command:

.. code-block:: console

    $ module load SoX/14.4.2-GCC-8.3.0

After this the |softwarename| command can be run from the terminal prompt with the ``sox`` command.

Further documentation on the usage of |softwarename| can be found at the following link:
http://sox.sourceforge.net/Docs/Documentation
--------------------------

Batch Usage
--------------------

The following is an example batch job:

.. code-block:: bash

    #!/bin/bash
    #SBATCH --nodes=1
    #SBATCH --ntasks-per-node=4
    #SBATCH --mem=8000
    #SBATCH --job-name=jobname
    #SBATCH --output=output
    #SBATCH --time=01:00:00
    #SBATCH --mail-user=a.person@sheffield.ac.uk
    #SBATCH --mail-type=ALL

    module load someModule/version
    srun --export=ALL softwarename

========

Installation notes
------------------

Installation method
^^^^^^^^^^^^^^^^^^^

This section is primarily for administrators of the system. |softwarename| has been installed using the default Easybuild config files.

Build logs and test reports can be found in ``$EBDEVELSOFTWARENAME`` with a given module loaded.

Testing method
^^^^^^^^^^^^^^^
Testing has been conducted by .........