FORD-Documentation-Tool-Integration module

Purpose of Module

This module add the first implementation of the FORD infrastructure for code documentation (courtesy D. Gresch, ETHZ).

Background Information

This module is produced during the ECAM/Wannier90-developer workshop held in San Sebastian. This coincided with the move of the Wannier90 repository to GitHub to enable easier integration of community contributions. One of the first such contributions was the ability to compute symmetry-adapted Wannier Functions. (For more background information, see Wannier code history)


Installation of wannier90 code is relatively simple. Detailed installing information is given by this link.


Test-Suite (Pull-Request 5) and Travis-CI integration (Pull-Request 6) are added to Wannier90 repository during this workshop.

Thus, each Pull-Request within this ECAM module passed the Travis-CI continuous integration test before being merged into the Wannier90 code. Within the Travis-CI test, a set of tests in Test-Suite are checked. Manual testing can be done through the following command:

$ make run-tests

If ‘run-custom-test-parallel’, it runs the specified test in parallel (4 process with MPI):

$ make run-custom-test-parallel testdir=example01

For more details, please see HERE.