Docs and examples for Quantum-Espresso and QE-util package

This project is maintained by jochym


This work was supported in part by a grant from the National Sciences and Engineering Research Council of Canada, University of Saskatchewan, and the Department of Computational Material Science of the Institute of Nuclear Physics, PAN, Cracow, Poland. The access to high performance supercomputers provided by Compute Canada (CLUMEQ and Westgrid) is acknowledged.

QE-doc is a set of tutorials for Quantum-Espresso environment inside iPython notebooks developed as a colaborative project between the Institute of Nuclear Physics and the University of Saskachwan.

The tutorials use QE-util and Elastic packages for the ASE system.

The docs and examples in the form of a series of iPython notebooks are viewable from the links below. If you open the links you can download the source from the page itself (icon in the top-right corner of the page). The support files as well as source for the tutorials are stored in the repository and can be cloned or directly downloaded as a zip archive.

Obviously, to get any use from these tutorials and to further use the software in the QE-util and Elastic packages you need to have at least cursory knowledge of the python language and iPython notebook environment. Go ahead and to the iPython website to teach yourself - if you need to.

But: no advanced knowledge of python is required for understanding the tutorials and you will pick up the required skills quickly when you start to experiment with the materials.

You will also need to understand at least the basics of the Quantum Espresso package. There is a large body of documents on the Quantum Espresso website as well as in other places (e.g. Tutorials prepared by the Q-E group). Since the whole system is based on the excellent ASE library you should study the documentation on their website at some point in time as well. This may wait until you start more serious experimentation. You should understand the tutorials without detailed knowledge of the ASE system. Finally, of course you will need understand the physics behind it all.


You can view the tutorials with just your browser (just click the links below), but to work on them (which is a whole point of having a tutorial!) you need a working environment - so you need to build and configure one.

The Installation document will help with this task. Do not be scared off by the multiple steps in the procedure. All should work quite smoothly, and at the end you will have an environment useful not only for viewing and experimenting with the tutorials but suitable for the day-to-day research work (it is actually a slimmed down and cleaned up version of my working environment).

The information concerned with local configuration at the University of Saskatchewan is included on the USASK NiPy page.

Alternatively, we have prepared a VirtualBox image of a fully installed and configured system. Ready to be imported into the virtualization software (README for the image). It is not the most effective way to use the software - but it is definitively the fastest one (it takes 3-5 minutes from downloading the image to opening first tutorial).

Then proceed to the tutorials - view them from the links below, download them (the download link is in the upper right corner of the tutorial page) and play with them - this is the fastest way to get a grip on the software.

Note: The software is under active development, so do expect some changes in the api from time to time.


Here is the list of tutorials. It will probably grow in time a little. If you wish to include your tutorial in the list we will be happy to add any material which concerned with similar tasks.