QE Docset

Docset for Quantum ESPRESSO (QE), an open-source package for electronic-structure calculations and materials modeling at the nanoscale, which should work with offline API documentation browsers such as Dash and Zeal.

Download

Manual install for Dash iOS

Download the tgz archive, extract the QuantumESPRESSO.docset folder and transfer to Dash via iTunes file share, then open settings in Dash on your device, and go to settings menu, then select “Transfer Docsets”, click the double arrow button to the right of the “Quantum ESPRESSO” item.

Manual install for Zeal

Download the tgz archive, extract the QuantumESPRESSO.docset folder and copy it to the docsets directory under the installation folder.

Screenshots

Why using docset?

Docset is an arranged package of (mostly) offline documents, you can access it anywhere without having to rely on a stable internet connection. What’s more, it is finely indexed, makes reading, jumping and searching for a keyword really easy.

This format is supported in beautifully designed document browsers such as Dash, Velocity and Zeal, which makes document reading an awesome journey.

Build & Develop

The docset generation code is open-sourced on GitHub. You can build the docset on your local machine according to the README.

You are also welcomed to contribute by submitting pull requests and issues. If you have any problem feel free to contact!