TREX/qmckl
1
0
Fork 0
mirror of https://github.com/TREX-CoE/qmckl.git synced 2024-11-03 20:54:09 +01:00
Code Issues Projects Releases Wiki Activity

Add the python API section

Browse Source
This commit is contained in:
q-posev 2022-08-31 16:45:11 +02:00
parent 03dec7038e
commit 170109d986
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -75,6 +75,27 @@ sudo make install
sudo make installcheck
```
## Python API
- [SWIG](https://www.swig.org) (>= 4.0) is required to build the Python API for maintainers
In order to install the `qmckl` Python package, first install the shared C library
`libqmckl` following the installation guide above and then run the following command:
```
make python-install
```
To test the installation, run
```
make python-test
```
Minimal example demonstrating the use of the `qmckl` Python API can be found in the
[test_api.py](https://github.com/TREX-CoE/qmckl/blob/master/python/test/test_api.py) file.
We highly recommend to use
[virtual environments](https://docs.python.org/3/tutorial/venv.html)
to avoid compatibility issues and to improve reproducibility.
## Installation procedure for Guix users