aiida-abacus
This is the AiiDA plugin for the ab-initio software package ABACUS.
Quick start
Try this plugin with a live JupyterLab server with Binder!
Click the Binder badge to launch a zero-install JupyterLab.
In two minutes you’ll have AiiDA + ABACUS fully set-up—complete with ready-to-run notebooks that let you submit calculations, track provenance, and visualize results right in your browser.
See Tutorials for installation locally.
Installation
Install from PyPI:
pip install aiida-abacus
Install from source:
First clone the source code:
git clone https://github.com/MCresearch/aiida-abacus.git
cd aiida-abacus
Then install locally:
- install using
pip
pip install .
# or pip install -e .
# if you want to make a change to the plugin
- install using
uv
uv sync # use --extra like [--extra pre-commit] to include optional dependencies
We recommend using aiida-abacus with ABACUS LTS (v3.10.0).
This is a Long-Term Supported stable release. The LTS version will only receive essential bug fixes and performance optimization PRs, without introducing code modifications that might affect computational accuracy and precision, nor changes to input parameter names & output formats.
Note that output format changes introduced by the rapidly iterating develop branch (for example, v3.9.0.3 and later v3.9.0.x released after v3.10.0) are currently not supported by the aiida-abacus parser. It is preferable to use ABACUS LTSv3.10.0 rather than develop release to produce data and work with aiida-abacus.
Pseudopotentials
We use the aiida-pseudo plugin to install and manage pseudopotentials.
It is easy to install pseudopotentials by aiida-pseudo CLI:
aiida-pseudo install pseudo-dojo -f upf -v 0.4 -x PBE -r SR -p standard
and load the pseudopotential family installed by calling
load_group in the launch script.
pseudo_family = load_group('PseudoDojo/0.4/PBE/SR/standard/upf')
At least one pseudo potential family should be installed. For more information on pseudo family, please refer to AiiDA pseudo plugin Documentation.
Documentation
See our online docs.
- Quick start
We ofter a quick start tutorial that provides two ways to get started: try Aiida-ABACUS instantly with our live JupyterLab environment powered by Binder, or follow the step-by-step guide to quickly set up a local installation and begin using the plugin.
See the examples directory to learn about how to run this plugin with scripts.
-
Get started with AiiDA. It is strongly recommended that the AiiDA setup and basics tutorials should be read and followed to ensure that the environment is set up correctly, while acquiring the relevant basic knowledge and basic concepts in AiiDA & getting to learn about using
verdiCLI/APIs. -
Documentation for ABACUS.
Usage
Here goes a quick demo of how to submit a calculation using this plugin:
verdi daemon start # make sure the daemon is running
cd examples
verdi run example_pw_Si2.py # run example calculation
verdi process list -a # check record of calculation
- Running calculations on a cluster is essentially the same, except that you need to configure the remote computer.
-
We provide simple setup demo config files
remote-slurm-ssh-setup.ymlandlocalhost-direct-local-setup.ymlin theexamplesdir. You can follow the guide in How to set up a computer to configure a computational resource. Please configureprepend_textaccording to your remote environment if Intel® oneAPI Toolkit is used to build ABACUS. -
You can also run the interactive Jupyter notebook
binder-example.ipynbin theexamplesdirectory locally for a glimpse intoaiida-abacus.
The plugin also includes verdi commands to inspect its data types:
verdi data abacus list
verdi data abacus export <PK>
Development
git clone https://github.com/MCresearch/aiida-abacus .
cd aiida-abacus
pip install --upgrade pip
pip install -e .[pre-commit,testing] # install extra dependencies
pre-commit install # install pre-commit hooks
pytest -v # discover and run all tests
Repository contents
src/aiida_abacus: Main source code ofaiida-abacusplugincalculations.py: TheAbacusCalculationcalcjob class.parsers.py: Theabacus.abacusdefault parser forAbacusCalculation.
examples/: Example of how to submit a calculation using this plugin via a script.
tests/: Basic tests supported by pytest. Install bypip install -e .[testing]and runpytest.
License
MIT
Metadata
Release files for aiida-abacus 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| aiida_abacus-0.3.1.tar.gz | 309.6 kB | Without provenance | Details for aiida_abacus-0.3.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| aiida_abacus-0.3.1-py3-none-any.whl | Python 3 | none | any | Details for aiida_abacus-0.3.1-py3-none-any.whl |
Total release size: 358.8 kB
Release files / aiida_abacus-0.3.1.tar.gz
| Download URL | aiida_abacus-0.3.1.tar.gz |
|---|---|
| Size | 309.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3077787791a0c844fa3f0fa0d52ce1dcd3b3a058a6babb6d42a3d97445cf5b74
|
|
BLAKE2b-256 checksum How to use checksums |
6967659e337389cbb3290e3256fb0f7334a61f5d9717080c0333025af1673bc3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.28.1
|
Release files / aiida_abacus-0.3.1-py3-none-any.whl
| Download URL | aiida_abacus-0.3.1-py3-none-any.whl |
|---|---|
| Size | 49.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ba45adf3d59d3462c7673e7bbd924bf8abed4b92c6b200f941c24c357069ae26
|
|
BLAKE2b-256 checksum How to use checksums |
5facb6f2ded80656c6113a4d325a19b5f34d853dac2261546583962ec7be07bd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.28.1
|
Security for aiida-abacus 0.3.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.