Software skeleton-page: Difference between revisions

From bwHPC Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 34: Line 34:
== Versions and Availability ==
== Versions and Availability ==


A current list of the versions available on the bwUniCluster and bwForclusters can be obtained from the Cluster Information System: [http://cis-hpc.uni-konstanz.de/prod.cis/programname| CIS Information on Programname]
A current list of the versions available on the bwUniCluster and bwForClusters can be obtained from the Cluster Information System: [http://cis-hpc.uni-konstanz.de/prod.cis/programname| CIS Information on Programname]


On the commandline of the the bwUni or bwFor clusters, you can get a list of the available i versions using
On the command line interface of any bwHPC cluster, a list of the available i versions using
<pre>
module avail kat/programname
$ module avail category/programname
</pre>


== Usage ==
== Usage ==
Line 43: Line 45:
=== Loading the module ===
=== Loading the module ===
You can load the default version of dacapo with the command
You can load the default version of dacapo with the command
<pre>
module load kat/programname
$ module load category/programname

</pre>
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 dacapo.


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 module X.
If you wish to load a specific (older) version, you can do so using e.g.
If you wish to load a specific (older) version, you can do so using e.g.
<pre>
module load kat/programname/0.0.0
$ module load category/programname/0.0.0
</pre>
to load the version 0.0.0
to load the version 0.0.0


Line 56: Line 61:
Scratch files are written to the current directory by default.
Scratch files are written to the current directory by default.
Please change to a local directory before starting your calculations. For example
Please change to a local directory before starting your calculations. For example
<pre>
mkdir -p /tmp/$USER/job_sub_dir
cd /tmp/$USER/job_sub_dir
$ mkdir -p /tmp/$USER/job_sub_dir
$ cd /tmp/$USER/job_sub_dir
</pre>


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


You can copy a simple interactive example to your home directory and run it, using:
You can copy a simple interactive example to your home directory and run it, using:
<pre>
mkdir ~/PROGRAMNAME-examples/
cp -r $PROGRAMNAME_EXA_DIR/ ~/PROGRAMNAME-examples/
$ mkdir ~/PROGRAMNAME-examples/
cd ~/PROGRAMNAME-examples/
$ cp -r $PROGRAMNAME_EXA_DIR/ ~/PROGRAMNAME-examples/
$ cd ~/PROGRAMNAME-examples/
blabla
$ blabla
</pre>


== Version-Specific Information ==
== Version-Specific Information ==


For information specific to a single version, see the information available via the module system with the command
For information specific to a single version, see the information available via the module system with the command
<pre>
module help kat/programname
$ module help category/programname
</pre>
<!-- remove comment to put page in category
<!-- remove comment to put page in category
[[Category:XYZ software]][[Category:bwunicluster]]
[[Category:XYZ software]][[Category:bwunicluster]]

Revision as of 16:47, 28 April 2014

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

Description

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

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 Programname

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

$ module avail category/programname

Usage

Loading the module

You can load the default version of dacapo with the command

$ module load category/programname

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 module X. If you wish to load a specific (older) version, you can do so using e.g.

$ module load category/programname/0.0.0

to load the version 0.0.0

Program Binaries

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.

Examples

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

$ mkdir ~/PROGRAMNAME-examples/
$ cp -r $PROGRAMNAME_EXA_DIR/ ~/PROGRAMNAME-examples/
$ cd ~/PROGRAMNAME-examples/
$ blabla

Version-Specific Information

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

$ module help category/programname