Software skeleton-page

Name
module load	category/name
License	e.g. GPL
Citing
Links	Homepage; Documentation
Graphical Interface	No (Yes)
Included in module

1 Description

Softwarename is used for worbeling the worbels. It makes use of advanced flubberdiflaps .

2 Versions and Availability

A current list of the versions available on the bwUniCluster and bwForClusters can be obtained from the Cluster Information System: CIS Information on Softwarename

On the command line interface of any bwHPC cluster, a list of the available i versions using

$ module avail category/softwarename

3 Usage

3.1 Loading the module

You can load the default version of software name with the command

$ module load category/softwarename

The module will try to load modules it needs to function (e.g. compiler/intel). If loading the module fails, check if you have already loaded one of those modules, but not in the version needed for software name. If you wish to load a specific (older) version, you can do so using e.g.

$ module load category/softwarename/0.0.0

to load the version 0.0.0.

3.3 Disk Usage

Scratch files are written to the current directory by default. Please change to a local directory before starting your calculations. For example

$ mkdir -p /tmp/$USER/job_sub_dir 
$ cd /tmp/$USER/job_sub_dir 

In case of multi-node parallel jobs, you might need to create the directory on all nodes used.

4 Examples

You can copy a simple interactive example to your home directory and run it, using:

$ mkdir ~/SOFTWARENAME-examples/
$ cp -r $SOFTWARENAME_EXA_DIR/ ~/SOFTWARENAME-examples/
$ cd ~/SOFTWARENAME-examples/
$ blabla

5 Version-Specific Information

For information specific to a single version, see the information available via the module system with the command

$ module help category/softwarename