Skip to content

Latest commit

 

History

History
228 lines (180 loc) · 9.13 KB

README.md

File metadata and controls

228 lines (180 loc) · 9.13 KB
Raw

Table of Contents

Synopsis

Serenity is a quantum chemistry code originally developed in the group of Johannes Neugebauer at the University of Münster.
Serenity has a strong focus on quantum chemical subsystem/embedding methods.

License and Copyright Info

Serenity is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Download

In order to download the source files of the latest Serenity release please visit:
https://github.com/qcserenity/serenity

Install

Please read the following instructions carefully.

Prerequisites

The code has been tested and compiled on Linux with GCC/G++ (Versions 7 and newer) and Clang (Versions 8 and newer) compilation with other compilers such as ICC should be possible on Linux. Old GCC/G++ compilers (4.8.5 or older) are known to be insufficient.

Furthermore, the code has been compiled on macOS using Clang but may experience problems depending on the CPU architecture. Compilation with GCC on macOS should most likely also be possible.

Compilation on and for Windows is not supported at the moment.

The following programs/libraries must be available on your system:

  • CMake (Version >= 3.12)
  • Boost (for package managers: including boost-devel)
  • OpenMP
  • Eigen3
  • HDF5 (Version >= 1.10.1; including header files and cmake files)
  • A recent GMP version, including C++ support (for libint2)
  • The standard GNU toolchain (make, tar, autoconf, libtool)

The following libraries will be automatically downloaded and installed together with Serenity (unless SERENITY_DOWNLOAD_DEPENDENCIES=OFF is set):

The following libraries are optional and needed for additional features:

Install Using CMake and Make

Extract or pull the source code, then create a build directory:

cd serenity
mkdir build
cd build

Then run cmake:

cmake ..

To compile Serenity for your specific CPU architecture, you can add:

cmake -DSERENITY_MARCH=native ..

(If the build folder is not located inside the main directory of Serenity please adapt the path accordingly.)

Finally run make and make install to build the program:

make

Please source serenity.sh located in the main folder to set all necessary environment variables:

cd ..
source serenity.sh

Install Including Python Interface

In order to activate the compilation of a Python interface to the code a flag can be set as follows

cmake -DSERENITY_PYTHON_BINDINGS=ON ..

additionally this and other flags can be toggled using ccmake

ccmake ..

The wrapper will be build for the Python version that CMake finds first In order to point CMake to a specific version of Python the following option can be used:

cmake -DPYTHON_EXECUTABLE=/usr/bin/python3 ..

The wrapper is shipped in form of a shared library (serenipy.so). In order for Python to find this package the library folder has to be present in the PYTHONPATH environment variable and the Serenity library has to be present in a path searched by the system for shared libraries. The latter is done when sourcing the serenity.sh script, the former requires to un-comment one line in this file. Afterwards the interface should importable as follows:

python
import serenipy as spy

Tests

Serenity comes with a decent set of unittests in order to run them source the serenity.sh script and run

PATH_TO_BUILD_DIR/bin/serenity_tests

Please use the complete path, or else GTEST might run into problems.

The Python wrapper comes with its own set of tests, these can be run using

python -m unittest discover PATH_TO_SERENITY/src/python/tests

Documentation

After configuring the project using CMake it is possible to create the documentation using:

make doc

Then you can open up the doc/html/index.html in a browser.
The python wrapper is not featured inside the documentation. Its documentation is available via pythons help() function, which displays the build-in doc-strings.

Troubleshooting:

If you run into trouble during the compilation please make sure all required libraries are present and read the output carfully. If you can make sure that your problems are not due to lacking requirements feel free to contact the main developers or preferably open an issue in the repository.

User Manual

The user manual resides in a seperate folder (manual) in this repository.

How to Cite Serenity

Serenity is published as:

J. P. Unsleber, T. Dresselhaus, K. Klahr, D. Schnieders, M. Böckers, D. Barton and J. Neugebauer,
Serenity: A Subsystem Quantum Chemistry Program,
J. Comput. Chem., 39, 788--798, (2018).

The BibTeX code would thus be:

@article{serenity_pub,
title = {Serenity: A Subsystem Quantum Chemistry Program},
author = {Jan P. Unsleber and Thomas Dresselhaus and Kevin Klahr and David Schnieders and Michael B{"o}ckers and Dennis Barton and Johannes Neugebauer},
journal = {J. Comput. Chem.},
volume = {39},
pages = {788--798},
year = {2018}
}

Please also cite the second publication: N. Niemeyer, P. Eschenbach, M. Bensberg, J. Tölle, L. Hellmann, L. Lampe, A. Massolle, A. Rikus, D. Schnieders, J. P. Unsleber, and J. Neugebauer, The subsystem quantum chemistry program Serenity, Wiley Interdiscip. Rev. Comput. Mol. Sci., 13, e1647, (2023).

The BibTeX code would thus be:

@article{serenity_update, title={The Subsystem Quantum Chemistry Program Serenity}, author={Niemeyer, Niklas and Eschenbach, Patrick and Bensberg, Moritz and T{"o}lle, Johannes and Hellmann, Lars and Lampe, Lukas and Massolle, Anja and Rikus, Anton and Schnieders, David and Unsleber, Jan P and Neugebauer, Johannes}, journal={Wiley Interdiscip. Rev. Comput. Mol. Sci.}, volume={13}, number={3}, pages={e1647}, year={2023}, publisher={Wiley Online Library} }

In order to allow others to reproduce your data and to give credit to all recent developers, please also reference the version of Serenity used by citing the correct code reference generated on Zenodo. The following DOI will always link to the newest version of the code:

10.5281/zenodo.4017420

For specific versions, please use the appropriate DOI.

Serenity relies on a few external libraries. Please cite Libint:
Libint: A library for the evaluation of molecular integrals of many-body operators over Gaussian functions, v2.7.0-beta6 Edward F. Valeev, http://libint.valeyev.net/ .

In case density functionals (for exchange-correlation or kinetic energy) are used, depending on the settings when compiling, please cite either Libxc or XCFun.
Libxc (6.1.0): S. Lehtola, C. Steigemann, M. J.T. Oliveira, and M. A.L. Marques. SoftwareX 7, 1–5 (2018). DOI: 10.1016/j.softx.2017.11.002
XCFun (v2.0.2): Ekström, U. (2020). XCFun: A library of exchange-correlation functionals with arbitrary-order derivatives. Zenodo. https://doi.org/10.5281/zenodo.3946698

Integrals over effective core potentials are provided by Libecpint.
Libecpint (1.0.7) : R. A. Shaw, J. G. Hill, J. Chem. Phys. 147, 074108 (2017); doi: 10.1063/1.4986887

Also, please include the scientific citations for the basis sets and density functionals you use.

Contact

Bugs and Feature Requests

For both bugs and feature requests please use the issue tracker on GitHub.

Other

For other question, requests or simply to give some feedback feel free to send an e-mail to: serenity@uni-muenster.de