Difference between revisions of "Software skeleton-page"
| Line 28: | Line 28: | ||
| <!-- mention if there is more than one software in the module, i.e. icc, ifort and debugger --> |
| <!-- mention if there is more than one software in the module, i.e. icc, ifort and debugger --> |
||
|} |
|} |
||
| + | |||
== Description == |
== Description == |
||
| + | '''Softwarename''' is used for worbeling the worbels. It makes use of advanced flubberdiflaps . |
||
| − | |||
| + | <br> |
||
| − | '''Programname''' is used for worbeling the worbels. It makes use of advanced flubberdiflaps . |
||
== 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/softwarename CIS Information on Softwarename] |
||
| − | |||
| − | 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 command line interface of any bwHPC cluster, 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> |
<pre> |
||
| − | $ module avail category/ |
+ | $ module avail category/softwarename |
</pre> |
</pre> |
||
| + | <br> |
||
== Usage == |
== Usage == |
||
| − | |||
=== Loading the module === |
=== Loading the module === |
||
| − | You can load the default version of '' |
+ | You can load the default version of ''software name'' with the command |
<pre> |
<pre> |
||
| − | $ module load category/ |
+ | $ module load category/softwarename |
</pre> |
</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 '' |
+ | 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. |
If you wish to load a specific (older) version, you can do so using e.g. |
||
<pre> |
<pre> |
||
| − | $ module load category/ |
+ | $ module load category/softwarename/0.0.0 |
</pre> |
</pre> |
||
to load the version 0.0.0. |
to load the version 0.0.0. |
||
| + | <br> |
||
=== Program Binaries === |
=== Program Binaries === |
||
| − | |||
=== Disk Usage === |
=== Disk Usage === |
||
Scratch files are written to the current directory by default. |
Scratch files are written to the current directory by default. |
||
| Line 67: | Line 67: | ||
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. |
||
| + | <br> |
||
== Examples == |
== Examples == |
||
| − | |||
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> |
<pre> |
||
| − | $ mkdir ~/ |
+ | $ mkdir ~/SOFTWARENAME-examples/ |
| − | $ cp -r $ |
+ | $ cp -r $SOFTWARENAME_EXA_DIR/ ~/SOFTWARENAME-examples/ |
| − | $ cd ~/ |
+ | $ cd ~/SOFTWARENAME-examples/ |
$ blabla |
$ blabla |
||
</pre> |
</pre> |
||
| + | <br> |
||
== 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> |
<pre> |
||
| − | $ module help category/ |
+ | $ module help category/softwarename |
</pre> |
</pre> |
||
| + | <br> |
||
| + | |||
<!-- 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 18:08, 29 April 2014
| Name | ||
|---|---|---|
| module load | category/name | |
| License | e.g. GPL | |
| Citing | ||
| Links | Homepage; Documentation | |
| Graphical Interface | No (Yes) | |
| Included in module | ||
Contents
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.2 Program Binaries
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
