Skip to main content

AiiDAlab quantum ESPRESSO app plugin for PP code

Project description

aiidalab-qe-pp

Plugin to perform data analysis and plotting using the pp.x code for the AiiDAlab Quantum ESPRESSO application

Installation

To install the aiidalab-qe-pp plugin, follow these steps:

git clone https://github.com/AndresOrtegaGuerrero/aiidalab-qe-pp.git
cd aiidalab-qe-pp
pip install -e .

Python

This plugin enables the computation of reduced-size cube files generated from Python using the AiiDA-PythonJob plugin. To ensure compatibility, set up an AiiDA code that utilizes the same Python version as your AiiDAlab environment. Ensure that your environment includes the pymatgen , cloudpickle and scikit-image libraries. Once configured, you can set up your AiiDA code with the following command:

verdi code create core.code.installed --config python_code.yml

In the python_code.yml file, specify the configuration for your HPC system within AiiDAlab as follows:

---
label: 'python-py39'
description: 'python at daint alps'
default_calc_job_plugin: 'pythonjob.pythonjob'
filepath_executable: '/users/username/miniconda3/envs/py39/bin/python'
computer: 'daint-alps'
prepend_text: |
   conda activate py39

append_text: ' '

Critic2 Integration

This plugin utilizes Critic2 software to compute Scanning Tunneling Microscopy (STM) images from Quantum ESPRESSO output data. For more information on Critic2 and its capabilities, please visit the official Critic2 website.

Critic2 AiiDAlab Installation

For installing Critic2 in your AiiDAlab please ensure you have gfortran and cmake

mamba install gfortran
mamba install cmake

Then follow the instructions for Critic2 Installation

Onced installed critic2

verdi code create core.code.installed --config code.yml

where code.yml for your localhost within AiiDAlab can be

---
label: 'critic2'
description: 'Critic 2 at localhost'
default_calc_job_plugin: 'critic2'
filepath_executable: '/home/jovyan/critic2/build/src/critic2'
computer: 'localhost'
prepend_text: |

append_text: ' '

License

The aiidalab-qe-pp plugin package is released under the MIT license. See the LICENSE file for more details.

Contact

If you have any questions or suggestions, feel free to reach out:

Acknowledgements

If you use the AiiDAlab QE app in your work, 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

We acknowledge support from:

  • the NCCR MARVEL funded by the Swiss National Science Foundation;

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_pp-0.1.5.tar.gz (39.6 kB view details)

Uploaded Source

Built Distribution

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

aiidalab_qe_pp-0.1.5-py3-none-any.whl (46.0 kB view details)

Uploaded Python 3

File details

Details for the file aiidalab_qe_pp-0.1.5.tar.gz.

File metadata

  • Download URL: aiidalab_qe_pp-0.1.5.tar.gz
  • Upload date:
  • Size: 39.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.33.1

File hashes

Hashes for aiidalab_qe_pp-0.1.5.tar.gz
Algorithm Hash digest
SHA256 3a18c04a192ab019eed74ef34e61a4ffeedc0d21540987eecdf515091b800011
MD5 49c1cebdd80885fd7e35e539a7c1aec3
BLAKE2b-256 78a44b86582c2f7c9a1e183d37f3c298e09e0b6abade1ed46f66bf4c71c316dd

See more details on using hashes here.

File details

Details for the file aiidalab_qe_pp-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for aiidalab_qe_pp-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9842e9aa0ae63eb25910534d528b1c905f6ca7d83d8e96dfe48b369ec5049e6b
MD5 7376c7037153e33b8e2abbf354eafed5
BLAKE2b-256 e1d3fdd2a95088148a95f17239e8178ceb8414a3fbf383b24c10ad2fe753b379

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