Difference between revisions of "Software skeleton-page"

From bwHPC Wiki
Jump to: navigation, search
 
(75 intermediate revisions by 3 users not shown)
Line 1: Line 1:
  +
<!--
−
<!--{| align="right" {{Table|width=40%}} -->
  
  +
Minimum-Breite sollte nicht unter 600px sein. Sind die Zeilen breiter, dann die
−
{|{{Softwarebox}}
  
  +
'width=600px'-Zeile loeschen oder anpassen (also vergroessern).
  +
class="wikitable" unbedingt so lassen!
  +
  +
Citing-Informationen entweder zwichen <small><small><pre>...</small><(small></pre>
  +
Tags setzen (Umbruch beachten) oder direkten Link auf Cite-Informationen.
  +
  +
&#124; = Pipe-Zeichen
  +
  +
Interne Verlinkungen benutzen. Syntax: [[#Ueberschrift|Link-Text]]
  +
  +
-->
  +
{| width=600px class="wikitable"
 
|-
  
|-
  +
! Description !! Content
−
! colspan="2" style="text-align:center" | Name
  
 
|-
  
|-
 
| module load
  
| module load
−
| category/name
 +
| category/name (e.g. chem/orca)
−
<!-- Neben CIS auch bereits über Kategorien abgedeckt
  
 
|-
  
|-
 
| Availability
  
| Availability
−
| [[bwUniCluster]] [[bwForCluster ENM]], [[bwForCluster MLS/WISO]], [[bwForCluster Theochem]], [[bwForCluster BinAC]]
 +
| [[bwUniCluster]] &#124; [[BwForCluster_Chemistry]]
  +
<!-- Verfuegbare Cluster (soweit bekannt):
−
-->
  
  +
[[bwUniCluster]] [[bwForCluster ENM]], [[BwForCluster_Chemistry]], [[bwForCluster BinAC]] -->
 
|-
  
|-
 
| License
  
| License
  +
| Link to SW-license-page, GPL ... [[#License|License]]
−
| e.g. GPL
  
 
|-
  
|-
−
|Citing
 +
| Citing
  +
| <small><small><pre>Citing-informations here</pre></small></small>
−
|
 
  +
or [link to citing-information or citing-description]
 
|-
  
|-
 
| Links
  
| Links
−
| [https://some.homepage.edu Homepage]; [https://some.other.page.edu Documentation]
 +
| [https://some.homepage.edu SW-Homepage] &#124; [https://some.otherpage.TLD some other pages] &#124; [https://some.homepage.edu SW-Documentation]
−
|
 
 
|-
  
|-
 
| Graphical Interface
  
| Graphical Interface
−
| No (Yes) <!-- Yes could link to some x11-forwarding/vnc instructions -->
 +
| No &#124; Yes <!-- Links zur Hardcopy, Beschreibung (X-forwardung, ssh -X ... -->
 
|-
  
|-
 
| Included in module
  
| Included in module
  +
| catetgory/module/name-dependance &#124; some/more/modules-here
−
| <!-- mention if there is more than one software in the module, i.e. icc, ifort and debugger -->
  
  +
<!-- e.g.: mpi/openmpi/1.6.5-gnu-4.8
  +
mention if there is more than one software in the module, i.e. icc, ifort and debugger -->
  +
|-
  +
| <font color=red>Updates/News</font>
  +
| Any other infos.... What's new!
 
|}
  
|}
   
−
== Description ==
+
= Description =
 
'''Softwarename''' is used for worbeling the worbels. It makes use of advanced flubberdiflaps .
  
'''Softwarename''' is used for worbeling the worbels. It makes use of advanced flubberdiflaps .
 
<br>
  
<br>
−  
 
This paragraph should give a short description of what the software does and should enable potential new users to decide if this is the software that might help them with their project.
  
This paragraph should give a short description of what the software does and should enable potential new users to decide if this is the software that might help them with their project.
  +
<br>
  +
<br>
  +
= Versions and Availability =
  +
A list of versions currently available on all bwHPC-C5-Clusters can be obtained from the
  +
<br>
  +
<big>
   
  +
[https://cis-hpc.uni-konstanz.de/prod.cis/ Cluster Information System CIS]
−
== Versions and Availability ==
  
  +
</big>
−
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]
  
  +
<!-- Include a direct link to the description in CIS here
−  
  +
e.g.: |url=https://cis-hpc.uni-konstanz.de/prod.cis/bwUniCluster/category/softwarename
−
On the command line interface of any bwHPC cluster, a list of the available i versions using
  
  +
e.g.: |url=https://cis-hpc.uni-konstanz.de/prod.cis/bwUniCluster/chem/orca
  +
Adjust 'height=nnn' to fit the contents without scrolling!
  +
-->
  +
<br>
  +
Include a direct link to the description in CIS here and remove this line!
  +
{{#widget:Iframe
  +
|url=https://cis-hpc.uni-konstanz.de/prod.cis/bwUniCluster/chem/gromacs <!-- modify here -->
  +
|width=90%
  +
|height=420
  +
|border=0
  +
}}
  +
<br>
  +
Show a list of available versions using 'module avail category/softwarename' on any HPC-C5 cluster.
 
<pre>
  
<pre>
  +
: EXAMPLE with Gromacs on the bwUniCluster
−
$ module avail category/softwarename
  
  +
$ module avail chem/gromacs
  +
------------------------ /opt/bwhpc/common/modulefiles -------------------------
  +
chem/gromacs/4.5.3_gridcount-1.4 chem/gromacs/5.0
  +
chem/gromacs/4.6.2(default) chem/gromacs/5.0.2
  +
chem/gromacs/4.6.5 chem/gromacs/5.0.5
 
</pre>
  
</pre>
 
<br>
  
<br>
  +
= License =
−  
−
== License ==
  
−  
 
Anything specific to the licensing model goes here. If the Program is GPL or one of the over very common free software licenses, you can probably remove this section. Things that should be mentioned here (if they apply)
  
Anything specific to the licensing model goes here. If the Program is GPL or one of the over very common free software licenses, you can probably remove this section. Things that should be mentioned here (if they apply)
 
- does the software use a license server
  
- does the software use a license server
Line 51: Line 89:
 
- are there other restrictions on the license (most proprietary software run on Universitiescan only be used for non-commercial research or teaching purposes)
  
- are there other restrictions on the license (most proprietary software run on Universitiescan only be used for non-commercial research or teaching purposes)
 
- Do any other restrictions apply
  
- Do any other restrictions apply
  +
<br>
−  
  +
<br>
−
== Usage ==
  
  +
= Usage =
−
=== Loading the module ===
  
  +
== Loading the module ==
 
You can load the default version of ''software name'' with the command
  
You can load the default version of ''software name'' with the command
  +
'module load category/softwarename'.
  +
Example:
 
<pre>
  
<pre>
 
$ module load category/softwarename
  
$ 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 ''software name''.
  
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.
  +
''$ module load category/softwarename/'version''' to load the version you desires.
 
<pre>
  
<pre>
  +
# EXAMPLE!
−
$ module load category/softwarename/0.0.0
  
  +
$ module avail chem/orca
  +
------------------------ /opt/bwhpc/common/modulefiles -------------------------
  +
chem/orca/3.0.1 chem/orca/3.0.3
  +
$ module load chem/orca/3.0.1
 
</pre>
  
</pre>
  +
<br>
−
to load the version 0.0.0.
  
  +
== Program Binaries ==
  +
Show the location and contents of the installed binaries in the main folder of the software
  +
and show some informations, too.
  +
e.g.: After loading the SOFTWARENAME module (''module load category/softwarename/'version''') this path is also set to the local $PATH- and [[#Software-Specific Environments|$SOFTWARENAME_BIN_DIR]] environments.
  +
<pre>
  +
$ ls -F (or ls -x) $SOFTWARE_BIN_DIR
  +
... list of content of software-bin-dir ...
  +
$
  +
</pre>
  +
What-is-what? Some more explanations here...
  +
<br>
 
<br>
  
<br>
   
−
=== Program Binaries ===
 +
== Disk Usage / Workspaces ==
−
=== Disk Usage ===
  
 
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
Line 76: Line 131:
 
</pre>
  
</pre>
   
  +
<br>
  +
<font color=red>Better solution:</font>
  +
Change to a local directory or to '''your local workspace''' (preferred) before starting your calculations.
  +
<br>
  +
'calc_repo' is an example name of a repository you created by using the command 'ws_allocate'.
  +
<br>
  +
<pre>
  +
$ cd $(ws_find calc_repo)
  +
['your-id'-calc_repo-0]$ pwd
  +
/work/workspace/scratch/'your-id'-calc_repo-0
  +
['your-id'-calc_repo-0]$
  +
</pre>
  +
<br>
 
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>
  +
<br>
  +
= Moab Submit Examples =
  +
You can copy a simple interactive example to your '''workspace''' and run it, using 'msub'
  +
<br>
  +
Strictly use the [[#Software-Specific Environments|$SOFTWARENAME_EXA_DIR]] environment-variable!
  +
<br>
  +
<pre>
  +
$ cd $(ws_find 'your_repo_name')
  +
$ cp $SOFTWARENAME_EXA_DIR/bwhpc-'softwarename'-example.moab .
  +
$ cp bwhpc-'softwarename'-example.moab my'softwarename'job.moab
  +
§ vi my'softwarename'job.moab # do your own modifications
  +
$ msub my'softwarename'job.moab # start job submission
  +
</pre>
 
<br>
  
<br>
   
  +
= Software-Specific Environments =
−
== Examples ==
  
  +
To see a list of all SOFTWARENAME environments set by the 'module load'-command use 'env | grep SOFTWARENAME'<br>
−
You can copy a simple interactive example to your home directory and run it, using:
  
  +
or the command 'module display category/softwarename/version' (you don't need to load the module before!).
 
<pre>
  
<pre>
  +
# EXAMPLE ONLY
−
$ mkdir ~/SOFTWARENAME-examples/
  
  +
$ module load chem/orca/3.0.3
−
$ cp -r $SOFTWARENAME_EXA_DIR/ ~/SOFTWARENAME-examples/
  
  +
$ env | grep ORCA
−
$ cd ~/SOFTWARENAME-examples/
  
  +
ORCA_VERSION=3.0.3
−
$ blabla
  
  +
ORCA_MAN_DIR=/opt/bwhpc/common/chem/orca/3.0.3/manual
  +
ORCA_EXA_DIR=/opt/bwhpc/common/chem/orca/3.0.3/bwhpc-examples
  +
ORCA_BIN_DIR=/opt/bwhpc/common/chem/orca/3.0.3
  +
ORCA_HOME=/opt/bwhpc/common/chem/orca/3.0.3
 
</pre>
  
</pre>
 
<br>
  
<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 a more detailed information specific to a specific SOFTWARENAME version, see the information available via the module system with the command
 
<pre>
  
<pre>
−
$ module help category/softwarename
 +
$ module help category/softwarename/'version'
 
</pre>
  
</pre>
 
<br>
  
<br>
  +
For a small abstract what SOFTWARENAME is about use the command
  +
<pre>
  +
$ module whatis category/softwarename/'version'
  +
</pre>
  +
<br>
  +
<pre>
  +
: EXAMPLES ONLY !!!
  +
$ module avail chem/orca
  +
------------------------------ /opt/bwhpc/common/modulefiles ---------------------------------------
  +
chem/orca/3.0.1 chem/orca/3.0.3
   
  +
$ module whatis chem/orca/3.0.1
−
<!-- remove comment to put page in category
  
  +
chem/orca/3.0.1 : Quantum chemistry package ORCA, version 3.0.1
  +
(command '/opt/bwhpc/common/chem/orca/3.0.1/orca')
  +
  +
$ module help chem/orca/3.0.1
  +
----------- Module Specific Help for 'chem/orca/3.0.1' ------------
  +
This module provides the quantum chemistry package ORCA version 3.0.1
  +
via command '/opt/bwhpc/common/chem/orca/3.0.1/orca'
  +
[...]
  +
Documentation:
  +
* Max-Planck-Institut fuer Chemische Energiekonversion
  +
https://cec.mpg.de/forum/portal.php
  +
* New features for version 3.0.1
  +
https://cec.mpg.de/forum/portal.php#a3
  +
* Manuals in pdf format:
  +
/opt/bwhpc/common/chem/orca/3.0.1/manual
  +
* Example data and a Moab example script can be found here:
  +
/opt/bwhpc/common/chem/orca/3.0.1/bwhpc-examples
  +
[...]
  +
</pre>
  +
<br>
  +
<!-- ====================================================
  +
remove comment to put page in category
 
----
  
----
 
[[Category:XYZ software]][[Category:bwUniCluster]]
  
[[Category:XYZ software]][[Category:bwUniCluster]]

Latest revision as of 13:10, 25 August 2022

Description Content
module load category/name (e.g. chem/orca)
Availability bwUniCluster | BwForCluster_Chemistry
License Link to SW-license-page, GPL ... License
Citing 
Citing-informations here

or [link to citing-information or citing-description]

Links SW-Homepage | some other pages | SW-Documentation
Graphical Interface No | Yes
Included in module catetgory/module/name-dependance | some/more/modules-here
Updates/News Any other infos.... What's new!

1 Description

Softwarename is used for worbeling the worbels. It makes use of advanced flubberdiflaps .
This paragraph should give a short description of what the software does and should enable potential new users to decide if this is the software that might help them with their project.

2 Versions and Availability

A list of versions currently available on all bwHPC-C5-Clusters can be obtained from the

Cluster Information System CIS
Include a direct link to the description in CIS here and remove this line! {{#widget:Iframe |url=https://cis-hpc.uni-konstanz.de/prod.cis/bwUniCluster/chem/gromacs |width=90% |height=420 |border=0 }}
Show a list of available versions using 'module avail category/softwarename' on any HPC-C5 cluster. 

: EXAMPLE with Gromacs on the bwUniCluster
$ module avail chem/gromacs
------------------------ /opt/bwhpc/common/modulefiles -------------------------
chem/gromacs/4.5.3_gridcount-1.4 chem/gromacs/5.0
chem/gromacs/4.6.2(default)      chem/gromacs/5.0.2
chem/gromacs/4.6.5               chem/gromacs/5.0.5


3 License

Anything specific to the licensing model goes here. If the Program is GPL or one of the over very common free software licenses, you can probably remove this section. Things that should be mentioned here (if they apply) - does the software use a license server - if yes, how many concurrent licenses can we use - are there other restrictions on the license (most proprietary software run on Universitiescan only be used for non-commercial research or teaching purposes) - Do any other restrictions apply

4 Usage

4.1 Loading the module

You can load the default version of software name with the command 'module load category/softwarename'. Example: 

$ 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/'version' to load the version you desires. 

# EXAMPLE!
$ module avail chem/orca
------------------------ /opt/bwhpc/common/modulefiles -------------------------
chem/orca/3.0.1 chem/orca/3.0.3
$ module load chem/orca/3.0.1


4.2 Program Binaries

Show the location and contents of the installed binaries in the main folder of the software and show some informations, too. e.g.: After loading the SOFTWARENAME module (module load category/softwarename/'version') this path is also set to the local $PATH- and $SOFTWARENAME_BIN_DIR environments. 

$ ls -F (or ls -x) $SOFTWARE_BIN_DIR
... list of content of software-bin-dir ... 
$

What-is-what? Some more explanations here...

4.3 Disk Usage / Workspaces

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


Better solution: Change to a local directory or to your local workspace (preferred) before starting your calculations.
'calc_repo' is an example name of a repository you created by using the command 'ws_allocate'. 

$ cd $(ws_find calc_repo)
['your-id'-calc_repo-0]$ pwd
/work/workspace/scratch/'your-id'-calc_repo-0
['your-id'-calc_repo-0]$


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

5 Moab Submit Examples

You can copy a simple interactive example to your workspace and run it, using 'msub'
Strictly use the $SOFTWARENAME_EXA_DIR environment-variable! 

$ cd $(ws_find 'your_repo_name')
$ cp $SOFTWARENAME_EXA_DIR/bwhpc-'softwarename'-example.moab .
$ cp bwhpc-'softwarename'-example.moab my'softwarename'job.moab 
§ vi my'softwarename'job.moab         # do your own modifications
$ msub my'softwarename'job.moab       # start job submission


6 Software-Specific Environments

To see a list of all SOFTWARENAME environments set by the 'module load'-command use 'env | grep SOFTWARENAME'
or the command 'module display category/softwarename/version' (you don't need to load the module before!). 

# EXAMPLE ONLY
$ module load chem/orca/3.0.3
$ env | grep ORCA
ORCA_VERSION=3.0.3
ORCA_MAN_DIR=/opt/bwhpc/common/chem/orca/3.0.3/manual
ORCA_EXA_DIR=/opt/bwhpc/common/chem/orca/3.0.3/bwhpc-examples
ORCA_BIN_DIR=/opt/bwhpc/common/chem/orca/3.0.3
ORCA_HOME=/opt/bwhpc/common/chem/orca/3.0.3


7 Version-Specific Information

For a more detailed information specific to a specific SOFTWARENAME version, see the information available via the module system with the command 

$ module help category/softwarename/'version'


For a small abstract what SOFTWARENAME is about use the command 

$ module whatis category/softwarename/'version'



: EXAMPLES ONLY !!!
$ module avail chem/orca
------------------------------ /opt/bwhpc/common/modulefiles ---------------------------------------
chem/orca/3.0.1 chem/orca/3.0.3

$ module whatis chem/orca/3.0.1
chem/orca/3.0.1      : Quantum chemistry package ORCA, version 3.0.1 
    (command '/opt/bwhpc/common/chem/orca/3.0.1/orca')

$ module help chem/orca/3.0.1
----------- Module Specific Help for 'chem/orca/3.0.1' ------------
This module provides the quantum chemistry package ORCA version 3.0.1
via command '/opt/bwhpc/common/chem/orca/3.0.1/orca' 
[...] 
Documentation: 
*  Max-Planck-Institut fuer Chemische Energiekonversion  
    https://cec.mpg.de/forum/portal.php
*  New features for version 3.0.1
    https://cec.mpg.de/forum/portal.php#a3
*  Manuals in pdf format:
    /opt/bwhpc/common/chem/orca/3.0.1/manual
*  Example data and a Moab example script can be found here:
    /opt/bwhpc/common/chem/orca/3.0.1/bwhpc-examples
[...]


Retrieved from "https://wiki.bwhpc.de/wiki/index.php?title=Software_skeleton-page&oldid=10997"