HPC/Applications/gaussian: Difference between revisions

From CNM Wiki
Jump to navigation Jump to search
 
(39 intermediate revisions by the same user not shown)
Line 15: Line 15:
features.
features.


=== Version note ===
=== User access ===
The g09 versions on Carbon are 64-bit versions with full support for shared memory and Linda parallelization.
Argonne's license agreement with Gaussian, Inc. restricts the use of Gaussian applications to '''Argonne employees'''.
$ module -l avail g09
- Package -----------------------------+- Versions -+- Last mod. ------
/opt/soft/modulefiles:
g09/A.02.x86_64-1                                    2010/04/29 21:07:18
g09/A.02.x86_64-2                                    2011/08/05 19:56:04
g09/C.01.x86_64-1                                    2012/01/16 20:05:38
g09/D.01.x86_64-1                                    2013/08/02 19:19:22
The last version is the default at the moment for
module load g09


=== Status ===
=== Versions ===
Our license agreement with Gaussian, Inc. restricts the use of Gaussian applications to Argonne employees.
The Gaussian versions on Carbon are 64-bit versions with full support for shared memory and Linda parallelization.
<syntaxhighlight lang="bash">
module -l avail gaussian
</syntaxhighlight>
'''gaussian/09'''/09.D.01.x86_64-3          2015/12/02 17:25:23
gaussian/16/16-A.03-1                  2017/10/16 12:42:41
gaussian/16/16-A.03-2                  2017/10/16 12:35:29
gaussian/16/16-B.01-1                  2019/05/28 16:56:37
'''gaussian/16'''/16-C.01-1                  2019/08/20 10:03:31
 
The last version is the default at present, obtained by the (recommended) version-free module command:
<syntaxhighlight lang="bash">
module load gaussian
</syntaxhighlight>


== Job script ==
== Job script ==
* Inspect the job script template (after having loaded the g09 module) at:
* Inspect the job script template (after having loaded the module) as follows:
  $G09_HOME/g09.job
  $GAUSSIAN_HOME/g16.job
* This script shows how to use a preprocessing script
g09preprocess


=== Usage ===
=== Usage ===
Line 41: Line 43:
* adapt the script for basic needs of several jobs, and individualize it by the PBS job name.
* adapt the script for basic needs of several jobs, and individualize it by the PBS job name.
The job name can be up to 15 characters long and should not contain unusual characters.  Set it, along with your project name and the walltime limit on the qsub command line:
The job name can be up to 15 characters long and should not contain unusual characters.  Set it, along with your project name and the walltime limit on the qsub command line:
  qsub -N foo [-l walltime=hhh:mm:ss]  g09.job
  qsub -N foo [-l walltime=hhh:mm:ss]  g16.job


=== Operation ===
=== Operation ===
Upon job execution, the script reads the input file, and the <code>g09preprocess</code> script interprets and modifies your input for use under PBS on Carbon, as follows:
Upon job execution, the script reads your Gaussian input file and modifies it use under PBS on Carbon, as follows:
* Link0-commands <code>%NProcShared=''ppn''</code> and <code>%LindaWorkers=n123,n124,n125,...</code> are inserted automatically.
* Link0-commands for parallelization are inserted automatically.
* Checkpoint-files named in <code>%chk</code> directives are identified and copied into the compute node's job-specifc <code>$TMPDIR</code>.  The  <code>%chk</code> specification will be changed to include <code>$TMPDIR</code>.  Note that this will be echoed in the g03 output as follows:
<!--  <code>%NProcShared=''ppn''</code> and <code>%LindaWorkers=n456,n457,n458,...</code> -->
   %chk=/tmp/12345.sched1.carboncluster/test0420.chk
<!--
* Checkpoint-files from <code>%chk</code> directives are '''copied into <code>$TMPDIR</code>''', a temporary directory located on the load compute node that is ''job-specifc''.  The  <code>%chk</code> specification will be changed to include <code>$TMPDIR</code>.  Note that this will be echoed in the Gaussian output as follows:
   %chk=/tmp/12345.sched5.carboncluster/test0420.chk
: Chk-file processing will be performed only for files within the current directory; to skip processing, specify a relative or absolute path, such as <code>%chk=./name.chk</code>
: Chk-file processing will be performed only for files within the current directory; to skip processing, specify a relative or absolute path, such as <code>%chk=./name.chk</code>
* At the end of the job, chk-files in <code>$TMPDIR</code> are moved to <code>$PBS_O_WORKDIR</code>.
* At the end of the job, chk-files in <code>$TMPDIR</code> are moved to <code>$PBS_O_WORKDIR</code>.
-->
== Tool for parsing Gaussian output ==
Much of the output from Gaussian is available in plaintext format in the log file.
Many users write grep-like utilities on their own to extract such information.
I wrote one as well, and it is available alongside each <code>gaussian</code> module.
The tool grew out of my own needs.
Contact me if you encounter a bug, need additional functionality, or simply find it useful.
=== Example ===
<syntaxhighlight lang="bash">
gauss-parse *out
</syntaxhighlight>
<pre>
# d3h_dec.out
# Energies (H)
#it E (H)                  dE (eV)    dE/step (eV)
1  -1421.2018695          0.00000000    0.00000000
2  -1421.28679099        -2.31083263    -2.31083263
3  -1421.38689495        -5.03480153    -2.72396890
# job end
</pre>
=== Documentation ===
To inspect the tool documentation, run:
gauss-parse --help
gauss-parse --man
To give an idea of scope, here is the output upon <code>--help</code>:
Usage:
    '''gauss-parse''' [''options''] [''gaussian-output-file'' ...]
Options:
    '''--energy'''    Output energies (default).
    '''--spectrum'''  Output eigenvalues.
    '''--diis'''      Print DIIS errors.
    '''--geometry'''  Output geometries (into separate files unless '''--join''' is given).
    '''--charge'''    Output Mulliken charges. When '''--Spin''' is used, output spin densities instead.
    '''--force'''    Output forces.
    '''--freq'''      Output frequencies.
    '''--archive'''  Expand archive entry [into plain text, with line breaks]
    '''--last'''      Print output for last frame only.
    For '''--energy''', '''--geometry''', or '''--force''' modes only:
    '''--pick''' ''frame_number''
                Output only the given frame number (counted from 1).
    '''--basename''' ''name''
                Select file name for output (an embedded <code>%d</code> will be increased for each input file)
    '''--join'''      Output geometry into a multi-frame xyz-format file.
    '''--input'''    Pick input orientation
    '''--std'''      Pick standard orientation
    '''--Spin'''      Use spin occupancy as scalar quantity (default: charge)
    '''--units''' ''unit''
                Convert energy and force units (default: no conversion).
    …


== Notes on Linda ==
== Notes on Linda ==
Gaussian is parallelized in two complementary ways:
* on a single node across its processors using ''shared memory'', and
* across different nodes via a subset of the ''Linda'' parallelization language – http://gaussian.com/link0/?tabid=1#Linda
=== Incomplete node use ===
=== Incomplete node use ===
g09/Linda may decide not to use the entirety of the nodes made available to it by the <code>g09preprocess</code> stage in the PBS job file.
Gaussian/Linda may decide not to use the entirety of the nodes made available to it by the preprocess stage in the PBS job file.
This section describes how to determine when this is the case and what to do about it.
This section describes how to determine when this is the case and what to do about it.


Line 60: Line 138:
  #p MP2/6-311G(2df,p) force symm=loose MaxDisk=250000000 test
  #p MP2/6-311G(2df,p) force symm=loose MaxDisk=250000000 test
  …
  …
This being run in the job file through <code>g09preprocess</code>:
This being run in the job file through the preprocessor produces the input that Gaussian will see, inserting the node names allocated by PBS:
#PBS -l nodes=2:ppn=8
  %NProcShared=32
  %LindaWorkers=n456,n457
g09preprocess test0420.com | g09 > test0420.out
which produces the input that g09 will see, inserting the node names allocated by PBS:
  %NProcShared=8
  %LindaWorkers=n994,n992
  %mem=20mw
  %mem=20mw
  #p MP2/6-311G(2df,p) force symm=loose MaxDisk=250000000 test
  #p MP2/6-311G(2df,p) force symm=loose MaxDisk=250000000 test
  …
  …
Gaussian will echo its input  line by line in its log file:
Gaussian will echo its input  line by line in its log file:
  Entering Gaussian System, Link 0=g09
  Entering Gaussian System, Link 0=/opt/apps/gaussian/16-C.01-1/libexec/avx2/g16/g16
  Initial command:
  Initial command:
  /opt/soft/g09-D.01.x86_64-1/g09/l1.exe "/tmp/341710.sched1.carboncluster/Gau-32350.inp" -scrdir="/tmp/341710.sched1.carboncluster/"
  /opt/apps/gaussian/16-C.01-1/libexec/avx2/g16/l1.exe "/tmp/3174927.sched5.carboncluster/Gau-38174.inp" -scrdir="/tmp/3174927.sched5.carboncluster/"
  Entering Link 1 = /opt/soft/g09-D.01.x86_64-1/g09/l1.exe PID=    32351.
Default linda workers: n532,n518
Default is to use  16 SMP processors on each worker.
  Entering Link 1 = /opt/apps/gaussian/16-C.01-1/libexec/avx2/g16/l1.exe PID=    38178.
 
Copyright (c) 1988-2019, Gaussian, Inc.  All Rights Reserved.
    
    
  Copyright (c) 1988,1990,1992,1993,1995,1998,2003,2009,2013,
  This is part of the Gaussian(R) 16 program.  It is based on
            Gaussian, Inc. All Rights Reserved.
the Gaussian(R) 09 system (copyright 2009, Gaussian, Inc.),
the Gaussian(R) 03 system (copyright 2003, Gaussian, Inc.),
  …
  …
  Cite this work as:
  Cite this work as:
  Gaussian 09, Revision D.01,
  Gaussian 16, Revision C.01,
  …
  …
  ******************************************
Gaussian 09:  EM64L-G09RevD.01 24-Apr-2013
                1-Aug-2013
  ******************************************
  ******************************************
  %NProcShared=8
  Gaussian 16: ES64L-G16RevC.01  3-Jul-2019
  '''Will use up to    8 processors via shared memory.'''
                22-Jan-2025
  %LindaWorkers=n994,n992
  ******************************************
  %mem=20mw
  %mem=1GB
  SetLPE:  input flags="-v -opt "Tsnet.Node.lindarsharg: ssh" "
  %chk=d3h_dec.chk
  SetLPE:    new flags="-v -opt "Tsnet.Node.lindarsharg: ssh" -nodelist 'n994.carboncluster n992.carboncluster'"
  SetLPE:    new flags="-opt 'Tsnet.Node.lindarsharg: ssh' -nodelist 'n532.carboncluster n518.carboncluster' -env GAUSS_MDEF=134217728 -env GAUSS_EXEDIR="/opt/apps/gaussian/16-C.01-1/libexec/avx2/g16:/opt/apps/gaussian/16-C.01-1/lib/bsd""
  '''Will use up to    2 processors via Linda.'''
  '''Will use up to    2 processors via Linda.'''
  --------------------------------------------------------------------
  -------------------------------------------
  #p MP2/6-311G force …
  #P ub3lyp/6-31g(d) opt freq scf=nosymm test
  --------------------------------------------------------------------
  -------------------------------------------
: The last line will be specific to your Gaussian [http://www.gaussian.com/g_tech/g_ur/m_input.htm route section]. So far, so good.
* I highly recommend to use the <code>'''#p'''</code> ("profuse") flag to better track progress through Gaussian's ''link'' stages.
: The last line will be specific to your Gaussian [https://gaussian.com/keywords/ route section].
* I highly recommend to use the <code>'''#P'''</code> (= "profuse") option to better track progress through Gaussian's ''link'' stages.
* The term ''processors'' is used inconsistently here. For shared memory, it means ''cores'', but for Linda it means ''nodes''.
* The term ''processors'' is used inconsistently here. For shared memory, it means ''cores'', but for Linda it means ''nodes''.
* You can track the use of Linda by:
* You can track the use of Linda by:
  grep exel ''file''.out
  grep exel ''file''.out
 
* Gaussian may decide to ''not use Linda'' after all. A note like this will appear in the log file:
(Enter /opt/soft/g09-D.01.x86_64-1/g09/linda-exe/l302.exel)
(Enter /opt/soft/g09-D.01.x86_64-1/g09/linda-exe/l401.exel)
* g09 may decide to ''not use Linda'' after all. A note like this will appear in the log file:
  PrsmSu:  requested '''number of processors reduced to:  6 ShMem  1 Linda.'''
  PrsmSu:  requested '''number of processors reduced to:  6 ShMem  1 Linda.'''
: In this case, decide wether it would be better to resubmit the job than to leave nodes allocated by PBS idle. It is possible that g09's decision is different for different Linda links. Only the longest-running link would be relevant for you to evaluate resubmission.
: In this case, decide wether it would be better to resubmit the job than to leave nodes allocated by PBS idle. It is possible that Gaussian's decision is different for different Linda links. Only the longest-running link would be relevant for you to evaluate resubmission.


=== Error messages ===
=== Error messages ===
When running jobs on more than one node (i.e., using Linda), you may see messages like these in a job's error stream:
When running jobs on more than one node (i.e., using Linda), you may see messages like these in a job's error stream:
  eval server 0 on n019.carboncluster has dropped it's connection.
  eval server 0 on n456.carboncluster has dropped it's connection.
  eval server 0 on n019.carboncluster has dropped it's connection.
  eval server 0 on n456.carboncluster has dropped it's connection.
  subprocess pid = 11505 has exited. status = 0x0000, id = 0, state = 17. command was /opt/soft/g09-D.01.x86_64-1/g09/linda8.2/opteron …
  subprocess pid = 11505 has exited. status = 0x0000, id = 0, state = 17. command was /opt/..../linda.../opteron …
  died after signing in successfully
  died after signing in successfully
  eval server 0 on n019.carboncluster has dropped it's connection.
  eval server 0 on n456.carboncluster has dropped it's connection.
  …
  …
* These messages can be ignored, according to http://umbc.rnet.missouri.edu/resources/How2RunGAUSSIAN.html :
* These messages can be ignored, according to http://umbc.rnet.missouri.edu/resources/How2RunGAUSSIAN.html :
Line 122: Line 196:
</div>
</div>


* The [http://gaussian.com/g_tech/g_ur/m_linda.htm environment variable GAUSS_FLAGS] (as set in the g09 modulefile) is now configured to include the flag <code>-v</code>, to better trace Linda operations on worker nodes. Additional lines like the following will show up in a job's error stream:
* The [http://gaussian.com/g_tech/g_ur/m_linda.htm environment variable GAUSS_FLAGS] (as set in the "gaussian" modulefile) is now configured to include the flag <code>-v</code>, to better trace Linda operations on worker nodes. Additional lines like the following will show up in a job's error stream:
  ntsnet: using executable file /opt/soft/g09-D.01.x86_64-1/g09/linda-exe/l302.exel
  ntsnet: using executable file /opt/apps/gaussian/16-C.01-1/libexec/avx2/g16/l302.exel
  ntsnet: trying to schedule 1 worker
  ntsnet: trying to schedule 1 worker
  ntsnet: scheduled a total of 1 worker
  ntsnet: scheduled a total of 1 worker
  ntsnet: starting master process on n994.carboncluster
  ntsnet: starting master process on n456.carboncluster
  ntsnet: starting 1 worker on n992.carboncluster
  ntsnet: starting 1 worker on n456.carboncluster
: This example shows how one link within a job of <code>#PBS -l nodes=2:ppn=8</code> gets executed under Linda.
: This example shows how one link within a job of <code>#PBS -l nodes=2:ppn=16</code> gets executed under Linda.

Latest revision as of 21:11, January 22, 2025

Introduction

Gaussian is an electronic structure program used by chemists, chemical engineers, biochemists, physicists and others for research in established and emerging areas of chemical interest.

Starting from the basic laws of quantum mechanics, Gaussian predicts the energies, molecular structures, and vibrational frequencies of molecular systems, along with numerous molecular properties derived from these basic computation types. It can be used to study molecules and reactions under a wide range of conditions, including both stable species and compounds which are difficult or impossible to observe experimentally such as short-lived intermediates and transition structures. This article introduces several of its new and enhanced features.

User access

Argonne's license agreement with Gaussian, Inc. restricts the use of Gaussian applications to Argonne employees.

Versions

The Gaussian versions on Carbon are 64-bit versions with full support for shared memory and Linda parallelization.

module -l avail gaussian
gaussian/09/09.D.01.x86_64-3           2015/12/02 17:25:23
gaussian/16/16-A.03-1                  2017/10/16 12:42:41
gaussian/16/16-A.03-2                  2017/10/16 12:35:29
gaussian/16/16-B.01-1                  2019/05/28 16:56:37
gaussian/16/16-C.01-1                  2019/08/20 10:03:31

The last version is the default at present, obtained by the (recommended) version-free module command:

module load gaussian

Job script

  • Inspect the job script template (after having loaded the module) as follows:
$GAUSSIAN_HOME/g16.job

Usage

Copy the template script and use it in one of two ways:

  • edit for each job as needed, or
  • adapt the script for basic needs of several jobs, and individualize it by the PBS job name.

The job name can be up to 15 characters long and should not contain unusual characters. Set it, along with your project name and the walltime limit on the qsub command line:

qsub -N foo [-l walltime=hhh:mm:ss]  g16.job

Operation

Upon job execution, the script reads your Gaussian input file and modifies it use under PBS on Carbon, as follows:

  • Link0-commands for parallelization are inserted automatically.

Tool for parsing Gaussian output

Much of the output from Gaussian is available in plaintext format in the log file. Many users write grep-like utilities on their own to extract such information.

I wrote one as well, and it is available alongside each gaussian module. The tool grew out of my own needs. Contact me if you encounter a bug, need additional functionality, or simply find it useful.

Example

gauss-parse *out
# d3h_dec.out
# Energies (H)
#it E (H)                   dE (eV)     dE/step (eV)
 1  -1421.2018695          0.00000000     0.00000000
 2  -1421.28679099        -2.31083263    -2.31083263
 3  -1421.38689495        -5.03480153    -2.72396890
…
# job end

Documentation

To inspect the tool documentation, run:

gauss-parse --help
gauss-parse --man

To give an idea of scope, here is the output upon --help:

Usage:
    gauss-parse [options] [gaussian-output-file ...]

Options:
    --energy    Output energies (default).

    --spectrum  Output eigenvalues.

    --diis      Print DIIS errors.

    --geometry  Output geometries (into separate files unless --join is given).

    --charge    Output Mulliken charges. When --Spin is used, output spin densities instead.

    --force     Output forces.

    --freq      Output frequencies.

    --archive   Expand archive entry [into plain text, with line breaks]

    --last      Print output for last frame only.

    For --energy, --geometry, or --force modes only:

    --pick frame_number
                Output only the given frame number (counted from 1).

    --basename name
                Select file name for output (an embedded %d will be increased for each input file)

   --join      Output geometry into a multi-frame xyz-format file.

   --input     Pick input orientation

   --std       Pick standard orientation

   --Spin      Use spin occupancy as scalar quantity (default: charge)

   --units unit
               Convert energy and force units (default: no conversion).
    …

Notes on Linda

Gaussian is parallelized in two complementary ways:

Incomplete node use

Gaussian/Linda may decide not to use the entirety of the nodes made available to it by the preprocess stage in the PBS job file. This section describes how to determine when this is the case and what to do about it.

Consider the following input:

%mem=20mw
#p MP2/6-311G(2df,p) force symm=loose MaxDisk=250000000 test
…

This being run in the job file through the preprocessor produces the input that Gaussian will see, inserting the node names allocated by PBS:

%NProcShared=32
%LindaWorkers=n456,n457
%mem=20mw
#p MP2/6-311G(2df,p) force symm=loose MaxDisk=250000000 test
…

Gaussian will echo its input line by line in its log file:

Entering Gaussian System, Link 0=/opt/apps/gaussian/16-C.01-1/libexec/avx2/g16/g16
Initial command:
/opt/apps/gaussian/16-C.01-1/libexec/avx2/g16/l1.exe "/tmp/3174927.sched5.carboncluster/Gau-38174.inp" -scrdir="/tmp/3174927.sched5.carboncluster/"
Default linda workers: n532,n518
Default is to use  16 SMP processors on each worker.
Entering Link 1 = /opt/apps/gaussian/16-C.01-1/libexec/avx2/g16/l1.exe PID=     38178.
 
Copyright (c) 1988-2019, Gaussian, Inc.  All Rights Reserved.
 
This is part of the Gaussian(R) 16 program.  It is based on
the Gaussian(R) 09 system (copyright 2009, Gaussian, Inc.),
the Gaussian(R) 03 system (copyright 2003, Gaussian, Inc.),
…
Cite this work as:
Gaussian 16, Revision C.01,

…
******************************************
Gaussian 16:  ES64L-G16RevC.01  3-Jul-2019
               22-Jan-2025 
******************************************
%mem=1GB
%chk=d3h_dec.chk
SetLPE:    new flags="-opt 'Tsnet.Node.lindarsharg: ssh'  -nodelist 'n532.carboncluster n518.carboncluster' -env GAUSS_MDEF=134217728 -env GAUSS_EXEDIR="/opt/apps/gaussian/16-C.01-1/libexec/avx2/g16:/opt/apps/gaussian/16-C.01-1/lib/bsd""
Will use up to    2 processors via Linda.
-------------------------------------------
#P ub3lyp/6-31g(d) opt freq scf=nosymm test
-------------------------------------------
…
The last line will be specific to your Gaussian route section.
  • I highly recommend to use the #P (= "profuse") option to better track progress through Gaussian's link stages.
  • The term processors is used inconsistently here. For shared memory, it means cores, but for Linda it means nodes.
  • You can track the use of Linda by:
grep exel file.out
  • Gaussian may decide to not use Linda after all. A note like this will appear in the log file:
PrsmSu:  requested number of processors reduced to:   6 ShMem   1 Linda.
In this case, decide wether it would be better to resubmit the job than to leave nodes allocated by PBS idle. It is possible that Gaussian's decision is different for different Linda links. Only the longest-running link would be relevant for you to evaluate resubmission.

Error messages

When running jobs on more than one node (i.e., using Linda), you may see messages like these in a job's error stream:

eval server 0 on n456.carboncluster has dropped it's connection.
eval server 0 on n456.carboncluster has dropped it's connection.
subprocess pid = 11505 has exited. status = 0x0000, id = 0, state = 17. command was /opt/..../linda.../opteron …
died after signing in successfully
eval server 0 on n456.carboncluster has dropped it's connection.
…

These messages are not indicative of a problem. They indicate that the Linda work in a Gaussian link is finished, and that Gaussian is continuing with a new link.

  • The environment variable GAUSS_FLAGS (as set in the "gaussian" modulefile) is now configured to include the flag -v, to better trace Linda operations on worker nodes. Additional lines like the following will show up in a job's error stream:
ntsnet: using executable file /opt/apps/gaussian/16-C.01-1/libexec/avx2/g16/l302.exel
ntsnet: trying to schedule 1 worker
ntsnet: scheduled a total of 1 worker
ntsnet: starting master process on n456.carboncluster
ntsnet: starting 1 worker on n456.carboncluster
This example shows how one link within a job of #PBS -l nodes=2:ppn=16 gets executed under Linda.