TREX/qmckl
1
0
Fork 0
mirror of https://github.com/TREX-CoE/qmckl.git synced 2024-12-22 12:23:56 +01:00
Code Issues Projects Releases Wiki Activity
553 Commits 16 Branches 9 Tags 96 MiB
Python 71.9%
C 22.3%
M4 2.5%
CSS 1%
Shell 0.7%
Other 1.6%
08f13d29b4
Go to file
Anthony Scemama 08f13d29b4 Cleaning tangle
2021-10-14 21:39:08 +02:00
.github/workflows Update test-build.yml 2021-10-14 16:17:48 +02:00
include Added new test 2021-10-13 10:10:09 +02:00
m4 Added configure scripts 2021-05-07 12:47:56 +02:00
man Add doc in dist, and text doc 2021-04-21 12:44:03 +02:00
org Remove unused variables 2021-10-14 18:54:48 +02:00
pkgconfig Clean configure 2021-06-03 01:32:50 +02:00
share Added new test 2021-10-13 10:10:09 +02:00
src Cleaning 2021-05-12 02:20:39 +02:00
to_be_processed Added a to_be_processes directory 2020-10-31 19:01:26 +01:00
tools Cleaning tangle 2021-10-14 21:39:08 +02:00
.gitignore Add the qmckl_probes interface (#2) 2021-07-23 12:01:14 +02:00
AUTHORS Automake working 2021-05-10 23:56:26 +02:00
autogen.sh Python script to build makefiles 2021-05-12 23:16:09 +02:00
ChangeLog Automake working 2021-05-10 23:56:26 +02:00
configure.ac Merge branch 'master' into trexio 2021-10-14 10:52:35 +02:00
COPYING Working on automake 2021-05-11 11:45:49 +02:00
INSTALL Automake working 2021-05-10 23:56:26 +02:00
LICENSE Initial commit 2020-10-13 15:08:11 +02:00
Makefile.am Merge branch 'master' into trexio 2021-10-14 10:52:35 +02:00
NEWS Automake working 2021-05-10 23:56:26 +02:00
README Working on automake 2021-05-11 11:45:49 +02:00
README.md README 2021-10-14 17:07:16 +02:00
vfc_tests_config.json Add the qmckl_probes interface (#2) 2021-07-23 12:01:14 +02:00

README.md

QMCkl: Quantum Monte Carlo Kernel Library

Build Status

The domain of quantum chemistry needs a library in which the main kernels of Quantum Monte Carlo (QMC) methods are implemented. In the library proposed in this project, we expose the main algorithms in a simple language and provide a standard API and tests to enable the development of high-performance QMCkl implementations taking advantage of modern hardware.

See the source code to read the documentation.

To clone the repository, use:

git clone https://github.com/TREX-CoE/qmckl.git

Installation

The simplest way to obtain the source files of QMCkl is to download a source distribution. This particular repository is for maintainers, who write the kernels in org-mode files and produce the source code and the documentation from these files.

For maintainers

./autogen.sh
QMCKL_DEVEL=1 ./configure --prefix=$PWD/_install --enable-silent-rules --enable-maintainer-mode

make
make check

For users

Obtain a source distribution and run

./configure 
make
make check
sudo make install
sudo make installcheck

Verificarlo CI

Since Verificarlo should not be a dependency of QMCkl, all Verificarlo functions are called only when the support is explicitely enabled (and ignored by the preprocessor otherwise). To enable vfc_ci support, the library should be configured with the following command :

QMCKL_DEVEL=1 ./configure --prefix=$PWD/_install \ --enable-silent-rules --enable-maintainer-mode --enable-vfc_ci --host=x86_64 \ CC="verificarlo-f" FC="verificarlo-f"

where CC and FC are set to verificarlo-f, and support is explicitely enabled with the –enable-vfc_ci flag. Configuring the library with the “standard” command will cause all calls to Verificarlo related functions to be ignored, and the library will be built as usual.

European flag TREX: Targeting Real Chemical Accuracy at the Exascale project has received funding from the European Union’s Horizon 2020 - Research and Innovation program - under grant agreement no. 952165. The content of this document does not represent the opinion of the European Union, and the European Union is not responsible for any use that might be made of such content.