Roughly speaking installing adcc boils down to installing openblas, adcc itself and a host program (i.e. SCF code) of your choice.
We have some more detailed guides for Debian and Ubuntu and macOS 10.13 (High Sierra) and 10.14 (Mojave), where we know things should be working. Please let us know if you managed to get adcc to work in the contexts of other OSes or distributions.
Debian and Ubuntu¶
openblas: Make sure you have the openblas BLAS library installed. This library is reasonably wide-spread, so there is a good chance it may already be installed on your system. If not, you can easily install it using
sudo apt-get install libopenblas-base
Compilation requirements: For compiling the Python extensions of adcc, you nee dto have the the
pythondevelopment headers and some essential build packages installed. This can be achieved via
sudo apt-get install python3-dev build-essential
adcc: Best install it from PyPi, using
pip install pybind11 # Install pybind11 first to suppress some error messages pip install adcc
macOS 10.13 (High Sierra) and 10.14 (Mojave)¶
macOS support is still experimental and so far only covers High Sierra and Mojave. We would love to hear your feedback in case things fail.
In adcc 0.13.1 there is a known bug for the pip installation on macOS, causing it to produce a corrupt installation, for a workaround, see https://github.com/adc-connect/adcc/pull/1.
This installation procedure will be supported from adcc 0.13.2.
Homebrew: Support for macOS currently requires the Homebrew package manager and a recent version of
brew install gcc@9). Hopefully, we will support
clangin the future.
adcc: Install from PyPi, using
pip install pybind11 # Install pybind11 first to suppress some error messages CXX=g++-9 CC=gcc-9 pip install adcc # Install adcc using the correct compiler for Python bindings
Installing a host program¶
Since adcc does not contain a self-consistent field (SCF) code you should install one of the supported SCF programs needs as well. Without expressing any particular preference, this documentation will mostly focus on Psi4 and PySCF, since these are very easy to obtain, install and use. If you prefer, feel free to install molsturm or veloxchem instead. Also note, that connecting to further host programs is not too hard and can be achieved via a dictionary or an HDF5 file, see Connecting host programs to adcc for details.
Finishing the setup¶
Congratulations! With these packages installed you are all set to run ADC calculations. Feel free to take a look at the Performing calculations with adcc section for learning how to use adcc in practice.
Finally, if you are interested in developing or contributing to adcc, even the better! In this case we hope the Developer’s notes will provide you with some useful pointers to get started.
If the installation of adcc fails due to an issue with compiling the python extension, check the following:
- Make sure your
clangor any other compiler for compiling the
adccextension. To enforce using
gcc(e.g. one from Homebrew or a custom openblas installation), set the environment variables
CXXto the full path of your C and C++ compilers, respectively.