Appendix B. Directory Structure of the ADF Package¶
Below is the list of major parts of the ADF package.
The bin directory¶
When the package is installed, the executable files are placed in $ADFHOME/bin. The binary executable file is usually called ‘adf.exe’, ‘band.exe’, and so on. On Windows it is adf.3.exe, band.3.exe, etc. There will also be files called just ‘adf’ or ‘band’. The latter are shell scripts that execute the corresponding binaries.
You should use the script files, rather than the executables directly. The script files take care of several convenient features (like the BASIS key described in the ADF User’s Guide) and provide a correct environment for running in parallel. See also the sample run scripts and the Examples document.
The $ADFBIN/setenv.sh and $ADFBIN/start scripts take care of setting up the environment and starting the binaries. If necessary, it parses the information provided by a batch system and sets up a machinefile (or an appfile) and runs tasks in parallel. Edit the file if you need to customize the way MPI programs are started.
The atomicdata directory¶
The directory atomicdata/ contains a large amount of data needed by programs from the ADF package at run time. For example, it contains basis sets for all atoms. Generally you should not modify any of the files in this directory.
The examples directory¶
The directory examples/ contains sample script and output files. The files with extension .run are shell scripts that also contain embedded input. Thus, these files should be executed, and not given as input to ADF.
The source code (adf, band, libtc, Install, ...)¶
The source files are only visible if you have a copy of the source code distribution. The source code files found in the program and library directories and subdirectories thereof have extensions .f, .f90, .c or .cu and contain FORTAN or C/CUDA code. Other source files are include files (files with extension .fh or .h). When compiling, the object files are generated in the folder $ADFHOME/build, and archived into libraries.
Compilation is done by $ADFBIN/foray, and the configure options are located in $ADFHOME/Install/-machinetype-/Forayflags.
The Install directory contains a configure script, some data files which provide generic input for configure (start, starttcl, and some more), a portable preprocessor cpp (based on Mouse cpp) and machine-specific files that are unpacked into the bin folder (precompiled packages), or the build folder (precompiled libraries). The machine-specific folders start with x86 or x86_64.
The Doc directory¶
All the user documentation for ADF is present in html format in $ADFBIN/Doc. Documentation is also available on the SCM website
The scripting directory¶
This directory contains some useful scripts that are part of the ADF package.