File: introduction.tex

package info (click to toggle)
psicode 3.4.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster, stretch
  • size: 46,416 kB
  • ctags: 18,563
  • sloc: cpp: 291,425; ansic: 12,788; fortran: 10,489; perl: 3,206; sh: 2,702; makefile: 2,205; ruby: 2,178; yacc: 110; lex: 53
file content (34 lines) | stat: -rw-r--r-- 1,717 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
%
% PSI Programmer's Manual
%
% Introduction
%
% Daniel Crawford, 24 January, 1996
% Revised by TDC July 2002
%

The purpose of this manual is to provide a reasonably detailed
overview of the source code and programming philosophy of \PSIthree,
such that programmers interested in contributing to the code will have
an easier task.  Section \ref{cvs} gives a succint explanation of the
steps required to obtain the source code from the main repository at
Virginia Tech.  (Installation instructions are given separately in the
installation manual or in \$PSI3/INSTALL.)  Section
\ref{Fundamental_PSI} discusses the essential elements of a C-language
\PSIthree\ program, with emphasis on the input parsing and I/O
functions.  Section \ref{Other_Libs} provides documentation of a
number of other important libraries, including the library of
functions for reading from the checkpoint file, \library{libchkpt.a},
the Quantum Trio miscellaneous function library, \library{libqt.a},
the \library{libiwl.a} for reading and writing one- and two-electron
integrals in the ``integrals with labels'' format.  Section
\ref{Style} offers advice on appropriate programming style for
\PSIthree\ code, and section \ref{Makefiles} describes the structure
of the package's \file{Makefile}s.  Section \ref{New_Code} gives a
brief overview of the necessary steps to adding a new module to
\PSIthree, section \ref{Debugging} gives some suggestions on debugging
it, and section \ref{Documentation} explains conventions for
documenting it.  The appendices provide important reference material,
including the currently accepted \PSIthree\ citation and format
information for some of the most important text files used by
\PSIthree\ modules.