This guide covers the usage of QE-emacs-modes package (aka QE-modes): an
open-source collection of Emacs major-modes for making the editing of
<#280#>QUANTUM ESPRESSO<#280#> (QE) input files somewhat easier and more comfortable with Emacs
editor. The package provides syntax highlighting (see
Figure~#fig:example#44>
QE-modes is free software, released under the GNU General Public License. See: http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt, or the file License in the <#282#>QUANTUM ESPRESSO<#282#> distribution.
The QE-modes package was written by Anton Kokalj. The implementation of QE-modes was made possible by several useful and helpful resources that are gratefully acknowledged, in particular: <#48#>Mode Tutorial<#48#> of Scott Andrew Borton (https://www.emacswiki.org/emacs/ModeTutorial for indentation code), <#50#>Derived Mode<#50#> and <#51#>Sample Mode<#51#> pages (https://www.emacswiki.org/emacs/DerivedMode, https://www.emacswiki.org/emacs/SampleMode) as well as the very useful resources of Xah Lee (http://ergoemacs.org/emacs/elisp_syntax_coloring.html). Last but not the least Sebastijan Peljhan is acknowledged for his work on xsf-mode that inspired the idea of writing the QE-modes.
![]() |
The installation of QE-modes package consists of two parts: (i)
installing the package itself and (ii) informing Emacs about it by
editing the
3.1 Installing the QE-modes package
Once the QE-modes-6.6.tar.gz archive is unpacked and you
are located in its root directory, the installation is trivial. Simply
copy the whole qe-modes subdirectory to appropriate place. To
facilitate this copying on Unix-like operating systems, one can use:
which will install the package in the qe-modes subdirectory of the
$HOME/.emacs.d/ directory. If you prefer to install it into
other directory, then use: