Skip to main content

Package for the AiiDAlab QE app

Project description

AiiDAlab Quantum ESPRESSO application

codecov Documentation Status

About

This is an AiiDAlab application for Quantum ESPRESSO workflows. The app allows the execution of a workflow with Quantum ESPRESSO that includes the selection of an input structure, its relaxation, the bands structure calculation, and more!

For developers

The package uses pre-commit hooks to check the style consistency of all commits. To use those you need to first install the pre-commit package itself, e.g. with:

pip install .[dev]

and then install the pre-commit hooks with

pre-commit install

The pre-commit checks should now be automatically executed prior to each commit.

To run unit tests in the AiiDAlab container, you need to run pytest from within the aiida-core-services conda environment:

conda activate aiida-core-services
pytest -sv tests

To run the integration tests, you need to build the Docker image first:

docker build . -t aiidalab/qe

Then, you can run the integration tests with:

pytest --driver Chrome tests_integration

Published Docker images

Supported tags released on Github Container Registry:

  • edge – the latest commit on the default branch (main)
  • latest – the latest stable release
  • $version – the version of a specific release (ex. 2022.1001)

Pull requests into the default branch are further released on ghcr.io with the pr-### tag to simplify the testing of development versions.

For maintainers

To create a new release, clone the repository, install development dependencies with pip install '.[dev]', and then execute bumpver update. This will:

  1. Create a tagged release with bumped version and push it to the repository.
  2. Trigger a GitHub actions workflow that creates a GitHub release.

For more details of the releases plan and management, please go to the wiki.

Additional notes:

  • Use the --dry option to preview the release change.
  • The release tag (e.g. a/b/rc) is determined from the last release. Use the --tag option to switch the release tag.
  • For making "outdated" release since we fix minor version to 2x.04.xx and 2x.10.xx, use e.g. bumpver update --set-version v23.10.0rc4 --ignore-vcs-tag to make the release.

Cite

If you use the AiiDAlab QE app in your research, please cite:

Wang, X., Bainglass, E., Bonacci, M., Ortega-Guerrero, A. et al.
Making atomistic materials calculations accessible with the AiiDAlab Quantum ESPRESSO app
npj. Comput. Mater. 12, 72 (2026). https://doi.org/10.1038/s41524-025-01936-4

Acknowledgements

We acknowledge support from:

MARVEL MaX MarketPlace BIG-MAP EU DOME 4.0
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiidalab_qe-26.6.0.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiidalab_qe-26.6.0-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file aiidalab_qe-26.6.0.tar.gz.

File metadata

  • Download URL: aiidalab_qe-26.6.0.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for aiidalab_qe-26.6.0.tar.gz
Algorithm Hash digest
SHA256 fe4ad68863e01926245ec5ac96412445a924bb91237411ba009567ec1da1eaa6
MD5 be4ac4b203537d5d22ace2c0c4308250
BLAKE2b-256 e274d280d70144b7e4128c4bec7ae1d6de423341882eeccc1516958a27aeaf32

See more details on using hashes here.

File details

Details for the file aiidalab_qe-26.6.0-py3-none-any.whl.

File metadata

  • Download URL: aiidalab_qe-26.6.0-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for aiidalab_qe-26.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 624209b89bc5aa1a00af4ae74f79b3f339c2b528e972cf3bc8bd74bf51c10e6d
MD5 9de926a0ca5ceccd2dc72d2f6a62ba3e
BLAKE2b-256 10879cde658101e81b4ed65581eda74b4808914730e19789119a89e9dd95bbce

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page