Skip to main content

AiiDA plugin for vibrational spectoscopy using Quantum ESPRESSO.

Project description

aiida-vibroscopy

AiiDA plugin that uses finite displacements and fields to compute phonon properties, dielectric, Born effective charges, Raman, non-linear optical susceptibility, and Pockels tensors, coming with lots of post-processing tools to compute infrared (absorption and reflectivity) and Raman spectra in different settings.

Latest release PyPI versionPyPI pyversions
References Static Badge
Getting help Docs status Discourse status
Build status Build Status Coverage Status
Activity PyPI-downloads Commit Activity
Community Discourse

Installation

To install from PyPI, simply execute:

pip install aiida-vibroscopy

or when installing from source:

git clone https://github.com/bastonero/aiida-vibrosopy
pip install .

Command line interface tool

The plugin comes with a builtin CLI tool: aiida-vibroscopy. For example, the following command should print:

> aiida-vibroscopy launch --help
Usage: aiida-vibroscopy launch [OPTIONS] COMMAND [ARGS]...

  Launch workflows.

Options:
  -v, --verbosity [notset|debug|info|report|warning|error|critical]
                                  Set the verbosity of the output.
  -h, --help                      Show this message and exit.

Commands:
  dielectric      Run an `DielectricWorkChain`.
  harmonic        Run a `HarmonicWorkChain`.
  iraman-spectra  Run an `IRamanSpectraWorkChain`.
  phonon          Run an `PhononWorkChain`.

How to cite

If you use this plugin for your research, please cite the following works:

Lorenzo Bastonero and Nicola Marzari, Automated all-functionals infrared and Raman spectra, npj Computational Materials 10, 55 (2024)

Sebastiaan. P. Huber et al., AiiDA 1.0, a scalable computational infrastructure for automated reproducible workflows and data provenance, Scientific Data 7, 300 (2020)

Martin Uhrin et al., Workflows in AiiDA: Engineering a high-throughput, event-based engine for robust and modular computational workflows, Computational Materials Science 187, 110086 (2021)

Please, also cite the underlying Quantum ESPRESSO and Phonopy codes references.

If you also calculate the Pockels tensors in a post-processing step, please also consider to cite:

Virginie de Mestral el al., Ab initio functional-independent calculations of the clamped Pockels tensor of tetragonal barium titanate, Phys. Rev. B 111, 184306 (2025)

License

The aiida-vibroscopy plugin package is released under a special academic license. See the LICENSE.txt file for more details.

Acknowlegements

We acknowledge support from:

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

aiida_vibroscopy-1.3.0.tar.gz (110.4 kB view details)

Uploaded Source

Built Distribution

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

aiida_vibroscopy-1.3.0-py3-none-any.whl (135.3 kB view details)

Uploaded Python 3

File details

Details for the file aiida_vibroscopy-1.3.0.tar.gz.

File metadata

  • Download URL: aiida_vibroscopy-1.3.0.tar.gz
  • Upload date:
  • Size: 110.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for aiida_vibroscopy-1.3.0.tar.gz
Algorithm Hash digest
SHA256 ae1c6c622ef35a1f82ddcf3d21015e2787fa28520635a7e23edcf38ec886898e
MD5 56097c26efcd411c1740c8f8448652dc
BLAKE2b-256 b077b88bc2f90b1f1a3cdf4e2c2a79429548acf3eb211d10f451d6854025f252

See more details on using hashes here.

File details

Details for the file aiida_vibroscopy-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aiida_vibroscopy-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f528f70aa651d86ed6e66cf5ca8e69ad5df4b353a84dcf1c06903b0cfca6174a
MD5 d945b7cb221fdcdecc9bd14f46b1ddf5
BLAKE2b-256 b5404d6ed56a79c8869f5073aaaf70f5b92306cc37bb46d5db6e209add93e03e

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