MCPcopy Index your code
hub / github.com/aiidalab/aiidalab-qe

github.com/aiidalab/aiidalab-qe @v26.06.5

Chat with this repo
repository ↗ · DeepWiki ↗ · release v26.06.5 ↗ · + Follow
1,167 symbols 3,590 edges 148 files 314 documented · 27%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

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

```

Core symbols most depended-on inside this repo

get_model
called by 79
src/aiidalab_qe/common/mixins.py
on_click
called by 43
src/aiidalab_qe/common/link_button/link_button.py
_get_default
called by 38
src/aiidalab_qe/app/configuration/advanced/pseudos/model.py
get_models
called by 34
src/aiidalab_qe/common/mixins.py
refresh
called by 23
src/aiidalab_qe/common/setup_codes.py
add_model
called by 22
src/aiidalab_qe/common/mixins.py
shallow_copy_nested_dict
called by 17
src/aiidalab_qe/utils.py
update
called by 13
src/aiidalab_qe/app/result/components/status/tree.py

Shape

Method 822
Function 205
Class 139
Route 1

Languages

Python100%
TypeScript1%

Modules by API surface

src/aiidalab_qe/common/widgets.py105 symbols
src/aiidalab_qe/common/panel.py71 symbols
src/aiidalab_qe/app/result/components/status/tree.py48 symbols
src/aiidalab_qe/common/wizard.py38 symbols
tests/conftest.py34 symbols
tests/test_status.py29 symbols
src/aiidalab_qe/common/mixins.py29 symbols
src/aiidalab_qe/common/bands_pdos/bandpdosplotly.py28 symbols
src/aiidalab_qe/common/bands_pdos/model.py25 symbols
src/aiidalab_qe/common/bands_pdos/utils.py22 symbols
src/aiidalab_qe/app/submission/step.py20 symbols
src/aiidalab_qe/app/app.py20 symbols

For agents

$ claude mcp add aiidalab-qe \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page