General Structure

External libraries:

  • parts of the C++ Boost libraries are used to provide various functionality, like timing and metaprogramming. The source for the 1.54.0 release is shipped with the module’s source code. Some of the libraries used need to be compiled. Boost is released under the terms of the Boost Software License, v1.0 (see also http://www.boost.org/users/license.html) We encourage the use of Boost whenever some functionality has already been coded within those libraries. However, consider carefully the introduction of functionality depending on compiler Boost libraries.
  • the Eigen template library for linear algebra. Almost every operation involving matrices and vectors is performed through Eigen. Eigen provides convenient type definitions for vectors and matrices (of arbitrary dimensions) and the corresponding operations. Have a look here for a quick reference guide to the API and at the getting started guide to get started. Eigen is distributed under the terms of the Mozilla Public License, v2.0
  • the Getkw library by Jonas Juselius is used to manage input. It is distributed under the terms of the GNU General Public License, v2.0 under the terms of the MIT License.
  • the XCFun library by Ulf Ekström under the terms of the GNU General Public License, v2.0
Documentation build:
  • the build of this documentation has been copied with minor adaptations from the PCMSolver API. In particular the Sphinx configuration script (conf.py) and the Doxygen configuration file (Doxygen.in) and the corresponding cmake structure (FindSphinx, find_python_module).