User Tools

Site Tools


howto:generate_manual

Howto generate the Input Reference Manual

Step 1: Download an XSTL processor

We use the Saxon-HE (home edition) version 9 . It can be downloaded from http://saxon.sourceforge.net/

Step 2: Compile CP2K

This is explained in detail elsewhere.

Step 3: Generate an intermediated XML file

$ cp2k.popt --xml 

This generates the file cp2k_input.xml which contains the entire input description.

Step 4: Goto cp2k/tools/manual

$ cd cp2k/tools/manual
$ java -jar saxon9he.jar  -o:index.html cp2k_input.xml cp2k_input.xslcp2k.popt

This will create the actual HTML files, which we make available at http://manual.cp2k.org/

howto/generate_manual.txt · Last modified: 2014/08/28 18:20 by oschuett