File: README

package info (click to toggle)
libxc 4.3.4-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 58,520 kB
  • sloc: ansic: 19,150; perl: 1,157; python: 803; f90: 639; makefile: 317; sh: 107
file content (162 lines) | stat: -rw-r--r-- 6,082 bytes parent folder | download | duplicates (3)
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
Libxc
=====

Libxc is a library of exchange-correlation functionals for
density-functional theory. The aim is to provide a portable, well
tested and reliable set of exchange and correlation functionals that
can be used by a variety of programs.

For more information, please check the manual at
http://www.tddft.org/programs/Libxc

INSTALLATION
============

Autotools
---------

The recommended way to install the library is by using GNU Autotools.

To install the library, just use the standard procedure:

./configure --prefix=PATH/TO/LIBXC
make
make check
make install

If you're not using a stable release tarball, you'll first need to
generate configure with:
autoreconf -i

CMake
-----

Support for CMake has also been recently contributed by Lori Burns.

The CMake file has the following caveats

* tested on Linux and Mac, static and shared lib, namespaced and
  non-namespaced headers, but really only to the extent that it works
  for Psi4
* all the fancy libtool options and Fortran interface _not_ tested
* test suite executed after build via `ctest`. But it has always
  totally passed or totally failed, which doesn't inspire confidence
* The generated `libxc_docs.txt` is large, and the generation step
  sometimes balks on it, leading to `xc_funcs.h` not found
  errors. Just execute again.

1) Building with CMake

Use the following procedure:

cmake -H. -Bobjdir
cd objdir && make
make test
make install

The build is also responsive to

  * static/shared toggle `BUILD_SHARED_LIBS`
  * install location `CMAKE_INSTALL_PREFIX`
  * namespacing of headers `NAMESPACE_INSTALL_INCLUDEDIR`
  * of course, `CMAKE_C_COMPILER`, `BUILD_TESTING`, and `CMAKE_C_FLAGS`

See CMakeLists.txt for options details. All these build options should
be passed as `cmake -DOPTION`.

2) Detecting with CMake

CMake builds install with `LibxcConfig.cmake`, `LibxcConfigVersion.cmake`, and
`LibxcTargets.cmake` files suitable for use with CMake
[`find_package()`](https://cmake.org/cmake/help/v3.2/command/find_package.html)
in `CONFIG` mode.

* `find_package(Libxc)` - find any xc libraries and headers

* `find_package(Libxc 3.0.0 EXACT CONFIG REQUIRED COMPONENTS static)`
  - find Libxc exactly version 3.0.0 built with static libraries or
  die trying

See cmake/LibxcConfig.cmake.in for details of how to detect the Config
file and what CMake variables and targets are exported to your
project.

3) Use with CMake

After `find_package(Libxc ...)`,

* test if package found with `if(${Libxc_FOUND})` or `if(TARGET
  Libxc::xc)`
* link to library (establishes dependency), including header and
  definitions configuration with `target_link_libraries(mytarget
  Libxc::xc)`
* include header files using `target_include_directories(mytarget
  PRIVATE $<TARGET_PROPERTY:Libxc::xc,INTERFACE_INCLUDE_DIRECTORIES>)`
* compile target applying `-DUSING_Libxc` definition using
  `target_compile_definitions(mytarget PRIVATE
  $<TARGET_PROPERTY:Libxc::xc,INTERFACE_COMPILE_DEFINITIONS>)`

FILE ORGANIZATION
=================

The distribution is organized as follows

./cmake      CMake helper files
./build      pkgconfig and Fedora spec files
./m4         m4 scripts used by configure.ac, and
             libxc.m4 used by other projects linking to libxc
./maple      the Maple source code for the functionals
./scripts    various scripts for libxc development
./src        source files
./testsuite  regression tests

The most important contents of the src directory for users are

xc.h         main header file with all external definitions
xc_funcs.h   automatically generated file with the list of functionals

In addition, developers will be interested in the following

util.h                         header file with internal definitions
*.f90 *.F90 xc_f.c string_f.h  Fortran 90 interface
*.f03 *.F03                    Fortran 2003 interface
funcs_*.c                      automatically generated files with
                               the functional definitions
functionals.c                  generic interface to simplify access
                               to the different families
lda.c gga.c mgga.c             interface to the different families of
                               functionals
special_functions.c            implementation of a series of special functions
hyb_gga_*.c                    definition of the different hybrid
                               GGA functionals
hyb_mgga_*.c                   definition of the different hybrid
                               meta-GGA functionals
lda_*.c                        definition of the different LDA functionals
gga_*.c                        definition of the different GGA functionals
mgga_*.c                       definition of the different meta-GGA functionals
work_lda.c                     code that simplifies the implementation of LDAs
work_gga_x.c                   code that simplifies the implementation of
                               exchange GGAs
work_gga_c.c                   code that simplifies the implementation of
                               some correlation GGAs
work_mgga_x.c                  code that simplifies the implementation of
                               exchange meta-GGAs
work_mgga_c.c                  code that simplifies the implementation of
                               some correlation meta-GGAs

Notes:

* Most functionals use the framework contained in a work_*.c
  file. This simplifies tremendously the implementation of the
  different functionals. The work_*.c are #include'd in the functional
  implementations through a preprocessor directive.

* Some files contain more than one functional, as similar functionals
  are usually grouped together. Therefore, the best way to find where
  a functional is implemented is by looking at its keyword in
  xc_funcs.h and using grep to find the correct file.

* The files where the functionals are defined are named as
  family_type_name.c, where: family - functional family (lda, gga,
  hyb_gga, or mgga) type - type of functional (x, c, xc, or k) name -
  name of the functional or class of functionals