JUSTUS2/Software/Turbomole: Difference between revisions
No edit summary |
K Siegmund (talk | contribs) No edit summary |
||
(46 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{Softwarepage|chem/turbomole}} |
|||
<!--{| align="right" {{Table|width=40%}} --> |
|||
{|{{Softwarebox}} |
|||
{| width=600px class="wikitable" |
|||
|- |
|- |
||
! Description !! Content |
|||
! colspan="2" style="text-align:center" | Name |
|||
|- |
|- |
||
| module load |
| module load |
||
| chem/turbomole |
| chem/turbomole |
||
|- |
|||
| Availability |
|||
| [[bwUniCluster]] |
|||
|- |
|- |
||
| License |
| License |
||
| [https://www.turbomole.org/turbomole/order-turbomole/ Commerical] |
|||
| commerical |
|||
|- |
|- |
||
|Citing |
| Citing |
||
| [https://www.turbomole.org/turbomole/turbomole-documentation/ See Turbomole manual] |
|||
| |
|||
|- |
|- |
||
| Links |
| Links |
||
| [ |
| [https://www.turbomole.com Homepage] | [https://www.turbomole-gmbh.com/turbomole-manuals.html Documentation] |
||
| |
|||
|- |
|- |
||
| User Forum |
|||
| Graphical Interface |
|||
| [https://www.turbo-forum.com/ external] |
|||
| No (Yes, for generating input) |
|||
|} |
|} |
||
= Description = |
|||
'''Turbomole''' is a general purpose ''quantum chemistry'' software package for ''ab initio'' electronic structure calculations and provides: |
|||
== Description == |
|||
* ground state calculations for methods such as Hartree-Fock, DFT, MP2, and CCSD(T); |
|||
'''Turbomole''' is a general purpose ''quantum chemistry'' software package for ''ab initio'' electronic structure calculations. |
|||
* excited state calculations at different levels such as full RPA, TDDFT, CIS(D), CC2, an ADC(2); |
|||
* geometry optimizations, transition state searches, molecular dynamics calculations; |
|||
* property and spectra calculations such as IR, UV/VIS, Raman, and CD; |
|||
* approximations like resolution-of-the-identity (RI) to speed-up the calculations without introducing uncontrollable or unknown errors; as well as |
|||
* parallel versions for all kind of jobs. |
|||
For more information on Turbmole's features please visit [https://www.turbomole-gmbh.com/program-overview.html http://www.turbomole-gmbh.com/program-overview.html]. |
|||
<br> |
<br> |
||
<br> |
|||
= 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/turbomole CIS Information on Turbomole] |
|||
On the command line interface of |
On the command line interface (CLI) of a particular bwHPC cluster a list of all available Turbomole versions can be inquired as followed |
||
<pre> |
<pre> |
||
$ module avail chem/turbomole |
$ module avail chem/turbomole |
||
</pre> |
</pre> |
||
A current list of the versions available on the bwUniCluster and bwForClusters can be found here: |
|||
https://www.bwhpc.de/software.php |
|||
== bwUniCluster 2.0 == |
|||
* Turbomole 7.4.1 |
|||
== bwForCluster JUSTUS 2 == |
|||
* Turbomole 7.5 |
|||
* Turbomole 7.4.1 |
|||
== Parallel computing == |
|||
The Turbomole ''Module'' subsumes all available parallel computing variants of Turbomole's binaries. Turbomole defines the following parallel computing variants: |
|||
* SMP = Shared-memory parallel computing based on OpenMP and Fork() with the latter using separated address spaces. |
|||
* MPI = Message passing interface protocol based parallel computing |
|||
However only one of the parallel variants or the sequential variant can be loaded at once and most Turbomole's binaries support only 1 or 2 of the parallelization variants. Like for Turbomole installations without the ''Module'' system of the bwHPC clusters, the variants have to be triggered by the environment variable $PARA_ARCH. |
|||
<br> |
|||
<br> |
<br> |
||
= Usage = |
|||
== Before loading the Module == |
|||
Before loading the Turbomole ''Module'' the parallel computing variant has to be defined via the environment variable $PARA_ARCH using the abbreviations SMP or MPI, e.g.: |
|||
You can load the default version of ''Turbomole'' with the command |
|||
<pre> |
|||
$ export PARA_ARCH=MPI |
|||
</pre> |
|||
will [[#Loading the Module|later load]] the '''MPI binary variants'''. If the variable $PARA_ARCH is not defined or empty, the sequential binary variants will be active once the Turbomole Module is loaded. |
|||
<br> |
|||
== Loading the Module == |
|||
You can load the default version of ''Turbomole'' with the command: |
|||
<pre> |
<pre> |
||
$ module load chem/turbomole |
$ module load chem/turbomole |
||
</pre> |
</pre> |
||
The Turbomole ''Module'' does not depend on any other ''Module'', but on the variable $PARA_ARCH. Moreover, Turbomole provides its own libraries regarding ''OpenMP'', ''Fork()'', and ''MPI'' based parallelization. |
|||
If you wish to load a specific (older) version you can do so by executing e.g.: |
|||
The ''Module'' Turbomole does not depend on any other ''Module''. Moreover, Turbomole provides its own libraries regarding ''OpenMP'', ''MPI'' and ''Global Array'' based usage. |
|||
If you wish to load a specific (older) version, you can do so using e.g. |
|||
<pre> |
<pre> |
||
$ module load chem/turbomole/ |
$ module load chem/turbomole/7.4.1 |
||
</pre> |
</pre> |
||
to load the version |
to load the version 7.4.1 |
||
<br> |
<br> |
||
== Switching between different parallel variants == |
|||
To switch between the different parallel variants provided by the Turbomole ''Module'', simply define the new parallel variant via $PARA_ARCH and load the ''Module'' again. Note that for switching between the parallel variants unloading of the Turbomole ''Module'' is not required. For instance to change to the MPI variant, execute: |
|||
=== Program Binaries === |
|||
<pre> |
|||
=== Disk Usage === |
|||
$ export PARA_ARCH=MPI |
|||
By default, scratch files of Turbomole binaries are placed in the directory of Turbmole binary execution. Please do not run your Turbomole calculations in your $HOME or $WORK directory. |
|||
$ module load chem/turbomole |
|||
</pre> |
|||
<br> |
|||
== Turbomole binaries == |
|||
The '''Turbomole''' software package consists of a set of stand-alone program binaries providing different features and parallelization support: |
|||
{| width=750px class="wikitable" |
|||
|- style=text-align:left" |
|||
! Binary !! Features !! OpenMP !! Fork !! MPI |
|||
|- style="vertical-align:top;" |
|||
| define |
|||
| Interactive input generator |
|||
| no |
|||
| no |
|||
| no |
|||
|- style="vertical-align:top;" |
|||
| dscf |
|||
| Energy calculations |
|||
| yes |
|||
| yes |
|||
| yes |
|||
|- style="vertical-align:top;" |
|||
| grad |
|||
| Gradient calculations |
|||
| yes |
|||
| yes |
|||
| yes |
|||
|- style="vertical-align:top;" |
|||
| ridft |
|||
| Energy calc. with fast Coulomb approximation |
|||
| no |
|||
| yes |
|||
| yes |
|||
|- style="vertical-align:top;" |
|||
| rdgrad |
|||
| Gradient calc. with fast Coulomb approximation |
|||
| yes |
|||
| yes |
|||
| yes |
|||
|- style="vertical-align:top;" |
|||
| ricc2 |
|||
| Electronic excitation energies, transition moments and properties of excited states |
|||
| yes |
|||
| no |
|||
| yes |
|||
|- style="vertical-align:top;" |
|||
| statpt |
|||
| Hessian and coordinate update for stationary point search |
|||
| no |
|||
| no |
|||
| no |
|||
|- style="vertical-align:top;" |
|||
| aoforce |
|||
| Analytic calculation of force constants, vibrational frequencies and IR intensities |
|||
| yes |
|||
| yes |
|||
| yes |
|||
|- style="vertical-align:top;" |
|||
| escf |
|||
| Calc. of time dependent and dielectric properties |
|||
| yes |
|||
| yes |
|||
| yes |
|||
|- style="vertical-align:top;" |
|||
| egrad |
|||
| gradients and first-order properties of excited states |
|||
| yes |
|||
| no |
|||
| yes |
|||
|- style="vertical-align:top;" |
|||
| odft |
|||
| Orbital-dependent energy calc. |
|||
| yes |
|||
| no |
|||
| no |
|||
|} |
|||
For the complete set of binaries and more detailed description of their features read [https://www.turbomole.org/turbomole/turbomole-documentation/ here]. |
|||
<br> |
<br> |
||
== |
== Turbomole tools == |
||
Turbomole's tool set contains scripts and binaries that help to prepare, execute workflows (such as geometry optimisation) and postprocess results. |
|||
You can copy a simple MOAB example to your home directory and run it, using: |
|||
{| width=750px class="wikitable" |
|||
|- style="text-align:left" |
|||
! Script !! Type !! Description |
|||
|- style="vertical-align:top;" |
|||
| x2t |
|||
| Preparation |
|||
| Converts XYZ coordinates into ''Turbomole'' coordinates. |
|||
|- style="vertical-align:top;" |
|||
| sdg |
|||
| Preparation |
|||
| Shows data group from ''control'' file: for example<span style="background:#edeae2;margin:10px;padding:1px;border:1px dotted #808080">$ sdg coord</span>shows current Turbomole coordinates used. |
|||
|- style="vertical-align:top;" |
|||
| jobex |
|||
| Optimization workflow |
|||
| Shell script that controls and executes automatic optimizations of molecular geometry parameters. |
|||
<!-- NumForce does currently not work with Moab+Slurm |
|||
|- style="vertical-align:top;" |
|||
| NumForce |
|||
| Workflow |
|||
| Shell script to calculates 2nd derivatives by numerical differentiation of gradients. Supports parallelization of tasks. |
|||
--> |
|||
|- style="vertical-align:top;" |
|||
| tm2molden |
|||
| Postprocessing |
|||
| Creates a molden format input file for the [[Molden]] program. |
|||
|- style="vertical-align:top;" |
|||
| eiger |
|||
| Postprocessing |
|||
| Script front-end of program ''eigerf'' to display HOMO-LUMO gap and MO eigenvalues. |
|||
|} |
|||
For the complete set of tools and more detailed description of their features read [http://www.turbomole-gmbh.com/manuals/version_6_5/Documentation_html/node9.html here]. |
|||
<br> |
|||
== Disk Usage == |
|||
By default, scratch files of Turbomole binaries are placed in the directory of Turbomole binary execution. Please do not run your Turbomole calculations in your $HOME or $WORK directory. |
|||
<br> |
|||
<br> |
|||
= Examples = |
|||
== Single node jobs == |
|||
=== Template provided by Turbomole Module === |
|||
The Turbomole ''Module'' provides a simple job script example of Cubane (C8H8) that runs an energy relaxation via MPI parallel ''dscf'' using 4 cores on a single node and its local file system. To simply run the example do the following steps: |
|||
<pre> |
<pre> |
||
$ module load chem/turbomole |
|||
$ mkdir -vp ~/Turbomole-example/ |
$ mkdir -vp ~/Turbomole-example/ |
||
$ cd ~/Turbomole-examples/ |
$ cd ~/Turbomole-examples/ |
||
$ cp -r $TURBOMOLE_EXA_DIR/* ~/Turbmole-example/ |
$ cp -r $TURBOMOLE_EXA_DIR/* ~/Turbmole-example/ |
||
$ sbatch bwHPC_turbomole_single-node_tmpdir_example.sh |
|||
$ msub bwUniCluster_turbomole_single-node_example.sh |
|||
</pre> |
</pre> |
||
The job example script |
The last step submits the job example script bwHPC_turbomole_single-node_example.sh to the queueing system. Once started on a compute node, all calculations will be done under an unique directory on the [[BwUniCluster_File_System#File_Systems|local file system]] of that particular compute node. |
||
<br> |
<br> |
||
=== Geometry optimization === |
|||
To do a geometry optimization of the [[#Single node job template provided by Turbomole Module|previous job example]] modify bwHPC_turbomole_single-node_tmpdir_example.sh by replacing the following line |
|||
<source lang="bash"> |
|||
time dscf > dscf.out 2>&1 |
|||
</source> |
|||
with |
|||
<source lang="bash"> |
|||
time jobex -dscf -keep 2>&1 |
|||
</source> |
|||
and submit the modified script to the queueing system on bwForCluster JUSTUS 2 via [[Slurm_JUSTUS_2|sbatch]] and bwUniCluster also via [[BwUniCluster_2.0_Slurm_common_Features|sbatch]], respectively. |
|||
The Turbomole command ''jobex'' controls the call of all the required Turbomole binaries for the geometry optimization. |
|||
<br> |
|||
<br> |
|||
= Turbomole-Specific Environment Variables = |
|||
To see a list of all Turbomole environments set by the 'module load'-command do the following: |
|||
<pre> |
|||
module show chem/turbomole 2>&1 | grep -E '(setenv|prepend-path)' |
|||
</pre> |
|||
= Version-Specific Information = |
|||
For specific information |
For specific information about the Turbomole version (e.g. 7.5) to be loaded do the following: |
||
<pre> |
<pre> |
||
module help chem/turbomole/7.5 |
|||
</pre> |
</pre> |
||
<br> |
|||
<!-- remove comment to put page in category |
|||
---- |
---- |
||
[[Category:Chemistry software]][[Category:bwUniCluster]] |
|||
--> |
Latest revision as of 11:31, 23 April 2024
The main documentation is available via |
Description | Content |
---|---|
module load | chem/turbomole |
License | Commerical |
Citing | See Turbomole manual |
Links | Homepage | Documentation |
User Forum | external |
Description
Turbomole is a general purpose quantum chemistry software package for ab initio electronic structure calculations and provides:
- ground state calculations for methods such as Hartree-Fock, DFT, MP2, and CCSD(T);
- excited state calculations at different levels such as full RPA, TDDFT, CIS(D), CC2, an ADC(2);
- geometry optimizations, transition state searches, molecular dynamics calculations;
- property and spectra calculations such as IR, UV/VIS, Raman, and CD;
- approximations like resolution-of-the-identity (RI) to speed-up the calculations without introducing uncontrollable or unknown errors; as well as
- parallel versions for all kind of jobs.
For more information on Turbmole's features please visit http://www.turbomole-gmbh.com/program-overview.html.
Versions and Availability
On the command line interface (CLI) of a particular bwHPC cluster a list of all available Turbomole versions can be inquired as followed
$ module avail chem/turbomole
A current list of the versions available on the bwUniCluster and bwForClusters can be found here: https://www.bwhpc.de/software.php
bwUniCluster 2.0
- Turbomole 7.4.1
bwForCluster JUSTUS 2
- Turbomole 7.5
- Turbomole 7.4.1
Parallel computing
The Turbomole Module subsumes all available parallel computing variants of Turbomole's binaries. Turbomole defines the following parallel computing variants:
- SMP = Shared-memory parallel computing based on OpenMP and Fork() with the latter using separated address spaces.
- MPI = Message passing interface protocol based parallel computing
However only one of the parallel variants or the sequential variant can be loaded at once and most Turbomole's binaries support only 1 or 2 of the parallelization variants. Like for Turbomole installations without the Module system of the bwHPC clusters, the variants have to be triggered by the environment variable $PARA_ARCH.
Usage
Before loading the Module
Before loading the Turbomole Module the parallel computing variant has to be defined via the environment variable $PARA_ARCH using the abbreviations SMP or MPI, e.g.:
$ export PARA_ARCH=MPI
will later load the MPI binary variants. If the variable $PARA_ARCH is not defined or empty, the sequential binary variants will be active once the Turbomole Module is loaded.
Loading the Module
You can load the default version of Turbomole with the command:
$ module load chem/turbomole
The Turbomole Module does not depend on any other Module, but on the variable $PARA_ARCH. Moreover, Turbomole provides its own libraries regarding OpenMP, Fork(), and MPI based parallelization. If you wish to load a specific (older) version you can do so by executing e.g.:
$ module load chem/turbomole/7.4.1
to load the version 7.4.1
Switching between different parallel variants
To switch between the different parallel variants provided by the Turbomole Module, simply define the new parallel variant via $PARA_ARCH and load the Module again. Note that for switching between the parallel variants unloading of the Turbomole Module is not required. For instance to change to the MPI variant, execute:
$ export PARA_ARCH=MPI $ module load chem/turbomole
Turbomole binaries
The Turbomole software package consists of a set of stand-alone program binaries providing different features and parallelization support:
Binary | Features | OpenMP | Fork | MPI |
---|---|---|---|---|
define | Interactive input generator | no | no | no |
dscf | Energy calculations | yes | yes | yes |
grad | Gradient calculations | yes | yes | yes |
ridft | Energy calc. with fast Coulomb approximation | no | yes | yes |
rdgrad | Gradient calc. with fast Coulomb approximation | yes | yes | yes |
ricc2 | Electronic excitation energies, transition moments and properties of excited states | yes | no | yes |
statpt | Hessian and coordinate update for stationary point search | no | no | no |
aoforce | Analytic calculation of force constants, vibrational frequencies and IR intensities | yes | yes | yes |
escf | Calc. of time dependent and dielectric properties | yes | yes | yes |
egrad | gradients and first-order properties of excited states | yes | no | yes |
odft | Orbital-dependent energy calc. | yes | no | no |
For the complete set of binaries and more detailed description of their features read here.
Turbomole tools
Turbomole's tool set contains scripts and binaries that help to prepare, execute workflows (such as geometry optimisation) and postprocess results.
Script | Type | Description |
---|---|---|
x2t | Preparation | Converts XYZ coordinates into Turbomole coordinates. |
sdg | Preparation | Shows data group from control file: for example$ sdg coordshows current Turbomole coordinates used. |
jobex | Optimization workflow | Shell script that controls and executes automatic optimizations of molecular geometry parameters. |
tm2molden | Postprocessing | Creates a molden format input file for the Molden program. |
eiger | Postprocessing | Script front-end of program eigerf to display HOMO-LUMO gap and MO eigenvalues. |
For the complete set of tools and more detailed description of their features read here.
Disk Usage
By default, scratch files of Turbomole binaries are placed in the directory of Turbomole binary execution. Please do not run your Turbomole calculations in your $HOME or $WORK directory.
Examples
Single node jobs
Template provided by Turbomole Module
The Turbomole Module provides a simple job script example of Cubane (C8H8) that runs an energy relaxation via MPI parallel dscf using 4 cores on a single node and its local file system. To simply run the example do the following steps:
$ module load chem/turbomole $ mkdir -vp ~/Turbomole-example/ $ cd ~/Turbomole-examples/ $ cp -r $TURBOMOLE_EXA_DIR/* ~/Turbmole-example/ $ sbatch bwHPC_turbomole_single-node_tmpdir_example.sh
The last step submits the job example script bwHPC_turbomole_single-node_example.sh to the queueing system. Once started on a compute node, all calculations will be done under an unique directory on the local file system of that particular compute node.
Geometry optimization
To do a geometry optimization of the previous job example modify bwHPC_turbomole_single-node_tmpdir_example.sh by replacing the following line
time dscf > dscf.out 2>&1
with
time jobex -dscf -keep 2>&1
and submit the modified script to the queueing system on bwForCluster JUSTUS 2 via sbatch and bwUniCluster also via sbatch, respectively.
The Turbomole command jobex controls the call of all the required Turbomole binaries for the geometry optimization.
Turbomole-Specific Environment Variables
To see a list of all Turbomole environments set by the 'module load'-command do the following:
module show chem/turbomole 2>&1 | grep -E '(setenv|prepend-path)'
Version-Specific Information
For specific information about the Turbomole version (e.g. 7.5) to be loaded do the following:
module help chem/turbomole/7.5