Software skeleton-page: Difference between revisions

From bwHPC Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
<!--
⚫
{| class="wikitable"
Minimum Breite sollte nicht unter 600px sein. Sind die Zeilen breiter, dann die
'width=600px'-Zeile loeschen oder anpassen.
class="wikitable" unbedingt so lassen!

&#124; = Pipe-Zeichen
-->
⚫
{| width=600px class="wikitable"
|-
|-
! Description !! Content
! Description !! Content
|-
|-
| module load
| module load
| category/name/<small>'version'<small>(optional)</small></small> (e.g. chem/orca/('version'))
| category/name (e.g. chem/orca)
|-
|-
| Availability
| Availability
Line 11: Line 18:
|-
|-
| License
| License
| Link to SW-license-page, GPL ...
| Link to SW-license-page, GPL ... [[#License|License]]
|-
|-
| Citing
| Citing
| citing-informations here or [link to citing-information or citing-description]
| Citing-informations here or [link to citing-information or citing-description]
|-
|-
| Links
| Links
Line 28: Line 35:
|}
|}


== 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>
Line 36: Line 43:
<br>
<br>


== Versions and Availability ==
= Versions and Availability =
A list of versions currently available on all bwHPC-C5-Clusters can be obtained from the
A list of versions currently available on all bwHPC-C5-Clusters can be obtained from the
<br>
<br>
Line 80: Line 87:
<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 90: Line 96:
<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
Line 108: Line 116:
<br>
<br>


=== Program Binaries ===
== Program Binaries ==
Show the location and contents of the installed binaries in the main folder of the software
Show the location and contents of the installed binaries in the main folder of the software
and show some informations, too.
and show some informations, too.
Line 122: Line 130:
<br>
<br>


=== Disk Usage / Workspaces ===
== Disk Usage / Workspaces ==
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 147: Line 155:
<br>
<br>


== Moab Submit Examples ==
= Moab Submit Examples =
You can copy a simple interactive example to your '''workspace''' and run it, using 'msub'
You can copy a simple interactive example to your '''workspace''' and run it, using 'msub'
<br>
<br>
Line 161: Line 169:
<br>
<br>


== Software-Specific Environments ==
= 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!).
To see a list of all SOFTWARENAME environments set by the 'module load'-command use 'env | grep SOFTWARENAME'<br>
or the command 'module display category/softwarename/version' (you don't need to load the module before!).


<pre>
<pre>
Line 177: Line 186:
<br>
<br>


== Version-Specific Information ==
= 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
For a more detailed information specific to a specific SOFTWARENAME version, see the information available via the module system with the command
<pre>
<pre>
Line 190: Line 199:


Example
Example

<pre>
<pre>
# EXAMPLE ONLY !!!
# EXAMPLE ONLY !!!

Revision as of 13:05, 1 December 2015

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
Graphical Interface No | Yes
Included in module catetgory/module/name-dependance | some/more/modules-here

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.

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!
EXAMPLE: {{#widget:Iframe |url=https://cis-hpc.uni-konstanz.de/prod.cis/bwUniCluster/chem/orca |width=90% |height=200 |border=1 }}

Open the above links by using the right mouse button and select "open in a new window" or "open in a new tab".


Show a list of available versions using 'module avail category/softwarename' on any HPC-C5 cluster. 

# EXAMPLE
$ module avail chem
------------------------ /opt/bwhpc/common/modulefiles -------------------------
chem/amber/12                    chem/molden/5.2.1
chem/babel/2.3.2(default)        chem/orca/3.0.1
chem/dacapo/2.7.16(default)      chem/orca/3.0.3
chem/dalton/2013                 chem/schrodinger/2014u1
chem/gamess/12052014             chem/schrodinger/2014u2
chem/gromacs/4.5.3_gridcount-1.4 chem/schrodinger/2015u3
chem/gromacs/4.6.2(default)      chem/smoldyn/2.31
chem/gromacs/4.6.5               chem/tmolex/4.0(default)
chem/gromacs/5.0                 chem/turbomole/6.5
chem/gromacs/5.0.2               chem/turbomole/6.6(default)
chem/gromacs/5.0.5               chem/vasp/5.3.3.4(default)
chem/jmol/12.2.34(default)       chem/vmd/1.9(default)
chem/lammps/1Feb14
$


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

Usage

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


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 -x $SOFTWARE_BIN_DIR
... list of content of software-bin-dir ... 
$

Some more explanations here...

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.

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


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
$


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'


Example 

# EXAMPLE 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=3171"