The official AiiDA plugin for CP2K.
Project description
AiiDA CP2K
Installation
If you use pip, you can install it as:
pip install aiida-cp2k
To install the plugin in an editable mode, run:
git clone https://github.com/aiidateam/aiida-cp2k
cd aiida-cp2k
pip install -e . # Also installs aiida, if missing (but not postgres/rabbitmq).
Links
- Documentation for the calculation examples and features of the plugin.
- Make an issue for bug reports, questions and suggestions.
- AiiDA to learn about AiiDA.
- CP2K to learn about CP2K.
For maintainers
Release
To create a new release, clone the repository, install development dependencies with pip install '.[dev]', and then execute bumpver update --major/--minor/--patch.
This will:
- Create a tagged release with bumped version and push it to the repository.
- Trigger a GitHub actions workflow that creates a GitHub release.
Additional notes:
- Use the
--dryoption to preview the release change. - The release tag (e.g. a/b/rc) is determined from the last release.
Use the
--tagoption to override the release tag.
Testing
To run the tests, you need to have Docker installed in your system. Once this is done, you can build the Docker image with the following command:
docker build -t aiida_cp2k_test .
Then, you can launch the container:
DOKERID=`docker run -d aiida_cp2k_test`
This will remeber the container ID in the variable DOKERID.
You can then run the tests with the following command:
docker exec --tty --user aiida $DOCKERID /bin/bash -l -c 'cd /home/aiida/aiida-cp2k/ && pytest'
To enter the container for manual testing do:
docker exec -it --user aiida $DOCKERID bash
License
MIT
Contact
Acknowledgements
This work is supported by:
- the MARVEL National Centre for Competency in Research funded by the Swiss National Science Foundation;
- the MaX European Centre of Excellence funded by the Horizon 2020 EINFRA-5 program, Grant No. 676598;
- the swissuniversities P-5 project "Materials Cloud".
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file aiida_cp2k-2.1.0b0.tar.gz.
File metadata
- Download URL: aiida_cp2k-2.1.0b0.tar.gz
- Upload date:
- Size: 631.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 09c6d5228e0a882da3ccd216f4b5d208a92df642a468d408a2a7d7b17b31ad7a |
|
| MD5 | 227681d039414da38df44fe56be885b3 |
|
| BLAKE2b-256 | e2cb8e73783acf650003926d6a847c7cae9e5273df049f1815d471c7e103502b |
File details
Details for the file aiida_cp2k-2.1.0b0-py3-none-any.whl.
File metadata
- Download URL: aiida_cp2k-2.1.0b0-py3-none-any.whl
- Upload date:
- Size: 29.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | af9872ca715d4d6b683e6ef07f48197c55c424e7749721d2c0897557928de8da |
|
| MD5 | 2a3382628473c5578d9f79690d72133e |
|
| BLAKE2b-256 | 588ad22c03bea150269f35941e975b31eac2a7bb26931b1f47d1b3953d6c3e59 |
