Go to file
Anthony Scemama c61556ef77 Working on automake 2021-05-11 11:45:49 +02:00
.github/workflows Add --without-munit 2021-05-07 13:16:46 +02:00
include Working on automake 2021-05-11 11:45:49 +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
munit@fbbdf1467e Make test 2020-10-17 00:28:49 +02:00
org Working on automake 2021-05-11 11:45:49 +02:00
share Working on automake 2021-05-11 11:45:49 +02:00
src Working on automake 2021-05-11 11:45:49 +02:00
to_be_processed Added a to_be_processes directory 2020-10-31 19:01:26 +01:00
tools Working on automake 2021-05-11 11:45:49 +02:00
.gitignore Fixing distcheck 2021-05-10 10:55:22 +02:00
.gitmodules Moved documentation in share/doc 2021-04-30 01:26:19 +02:00
AUTHORS Automake working 2021-05-10 23:56:26 +02:00
COPYING Working on automake 2021-05-11 11:45:49 +02:00
ChangeLog Automake working 2021-05-10 23:56:26 +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 Working on automake 2021-05-11 11:45:49 +02:00
Makefile.in Working on automake 2021-05-11 11:45:49 +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 Working on automake 2021-05-11 11:45:49 +02:00
TODO.org Error handling 2021-03-05 03:45:30 +01:00
configure.ac Working on automake 2021-05-11 11:45:49 +02:00
qmckl.pc.in Added configure scripts 2021-05-07 12:47:56 +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 --recursive https://github.com/TREX-CoE/qmckl.git

to dowload also the munit unit testing framework.

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

autoreconf 
QMCKL_DEVEL=1 ./configure --enable-debug
make
make check

For users

Obtain a source distribution and run

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

European flag TREX: Targeting Real Chemical Accuracy at the Exascale project has received funding from the European Unions 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.