Difference between revisions of "HowTo:adf"
(→Location of the program and setup)
|Line 20:||Line 20:|
== Location of the program and setup ==
== Location of the program and setup ==
The present version of ADF is
The present version of ADF is .. The programs in the ADF package reside in /opt/adf. To use ADF on machines, it is required that you read our licensing agreement and [http://www.hpcvl.org/sites/default/files/ADF_statement.pdf sign a statement]. You will then be made a member of a Unix group adf, which enables you to run the software
== Scratch files ==
== Scratch files ==
Revision as of 15:56, 26 May 2016
This is a short help file on how to use the computational Quantum Chemistry code "ADF" on our clusters. We require all users of this software to sign a statement. The software can only be accessed by persons who belong to a specific Unix group. See details below.
ADF stands for "Amsterdam Density Functional" and denotes a package of programs that uses Density Functional Theory (DFT) for electronic and molecular structure calculations. The package is geared towards chemists and physicists with an interest in the structure of molecules and solids.
The ADF package consists of two main components:
- ADF for molecular calculations
- BAND for calculations on solids
Unlike most other molecular/solid/electronic structure codes, ADF employs "Slater-type" basis sets, ie, functions that have an exponential behaviour, which are more suitable for the description of chemical systems than the more commonly employed "Gaussian type" ones. The downside of this are computational difficulties that may be circumvented by numerical integration. Since DFT depends largely on numerical integration anyhow, the "Slater approach" is particularly well-suited for DFT code.
ADF is arguably the best DFT code available at this time for transition metal compounds and solids.
ADF handles geometry optimizations, transition states, reaction paths, and infrared frequencies. It allows the calculation of a variety of properties, ranging from UV spectra (requiring the treatment of excited states) to NMR chemical shifts and spin-spin couplings (where the use of Slater-type bases is of great use). The BAND code can be used for calculations on polymers, surfaces and bulk solids.
Location of the program and setup
The present version of ADF is 2016.101. The programs in the ADF package reside in /opt/adf. To use ADF on our machines, it is required that you read our licensing agreement and sign a statement. You will then be made a member of a Unix group adf, which enables you to run the software.
ADF requires the sourcing of a setup script to function properly:
This script sets environment variables that are necessary for proper program execution and are used for the system to find executables and data files such as basis sets. Among others, SCMLICENSE is used by the license manager of the program to find a machine specific license file.
The above settings is best applied through a call to usepackage on our system. Issuing the command
will take care of this, as well as including the $ADFBIN directory in the $PATH. This command may also be placed into a login shell setup file (.bash_profile).
One of the settings is the environment variable GAUSS_SCRDIR which is required to redirect the temporary files that Gaussian uses to the proper scratch space, presently
where hpcXXXX stands for your username. If for some reason Gaussian does not terminate normally (e.g. a job gets cancelled), it leaves behind large scratch files which you may have to delete manually. To check if such files exist, type
ls -lt /scratch/hpcXXXX
Once you have determined that the scratch files are no longer needed (because the program that used them is not running any more), you can delete them by typing
Cleaning up the scratch space is the user's responsibility. If it is not done regularly, it can cause jobs to terminate, and much work to be lost.
Running Gaussian from a command line
To run Gaussian on our systems, you have to belong to a user group g98 (it's called that for historical reason, but it applies to all versions of Gaussian). You need to read our license agreement and signed a statement to be included in this user group. Once you are, you can access the executables.
A computation is performed by preparing an input file and pipe it to standard input of the program g09. Standard output should be caught in a log-file. We suggest you use the extensions .g09 for input files and .log for results.
Interactively, the command line to invoke Gaussian is thus:
g09 < test.g09 >test.gout
This will only work if you are a member of the g98 group and have set the environment correctly. Note that the interactive execution of Gaussian is only meant for test runs.
Gaussian input files are explained in the "User's Reference". It is impossible to give an outline here. Sample files can be found in
Note: It is absolutely essential to have a good idea about the size and complexity of your calculations before you start a Gaussian job. Many of the methods mentioned above have terrible scaling properties, i.e. the computational cost grows very quickly with the number of electrons, degrees of freedom, or number of basis functions used. We suggest you start with a small basis set and a cheap method, and then slowly increase those parameters.
Submitting (parallel) Gaussian jobs
If you want to run Gaussian on several processors on our machines, you have to include a line in your input file:
where we assume that you want to use 8 processors (cores, threads).
It is mandatory to submit a Gaussian job script through our scheduling software (see our Scheduler Help File for details).
Here is a "bare bones" sample of a Gaussian submission script:
#! /bin/bash #$ -S /bin/bash #$ -q abaqus.q #$ -l qname=abaqus.q #$ -cwd #$ -V #$ -M hpcXXXX@localhost #$ -m be #$ -o STD.out #$ -e STD.err #$ -pe shm.pe 8 g09 < sample.g09 > sample.log
- The first 6 lines of the script make sure the right shell is used, the program executes on the correct cluster, and all necessary setup is done.
- An email address for notifications is specified in the #$ -M line. We suggest "hpcXXXX@localhost" (hpcXXXX stands for the username). Place a file .forward containing your actual email address into your home directory.
- The -o and -e lines are used to tell the system where to write "standard output" and "standard error", i.e. the screen output.
- The #$ -pe gaussian.pe 8 line specifies the number of processors the scheduler will allocate (8 in this example). It is crucial to choose the same number as specified in the %nrocs= line of the input file.
The script (let's call it g09.sh) is submitted by the qsub command:
This must be done from the working directory, i.e. the directory that contains the input file and is supposed to contain the output. Also make sure that you have set up gaussian (use g09) before you submit a job.
Gaussian is a licensed program. The license held by the Centre for Advanced Computing is limited to our computers at our main site. That means that any of our users can use the program on our machines (but nowhere else), whether they are located at Queen's or not.
We require users of Gaussian to sign a statement in which they state that they are informed about the terms of the license to be included in the Gaussian user group named "g98". Please fax the completed statement to (613) 533-2015 or scan/email to firstname.lastname@example.org.
Where can I get more detailed information ?
- To learn the basics about Gaussian input and output, refer to the Gaussian 09 User's Reference.
- For templates, and to get many examples, check out /opt/gaussian/g09/bsd/examples.
- The Gaussian web page contains a lot of information.
- For hardcore computational chemists, there is the Gaussian IOPs Reference, useful if you want to tinker with default settings and internal parameters.
- These can be purchased from Gaussian Inc..
- Send to email@example.com. We're happy to help.