3.2 Documentation and Tutorials

Documentation for Nektar++ is provided in a number of forms:

• User Guide (LaTeX, compiled to pdf or html)

• Source code documentation (Doxygen compiled to html)

3.2.1 Dependencies

To build the User Guide and Developer’s Guide, the following dependencies are required:

• texlive-base

• texlive-latex-extra

• texlive-science

• texlive-fonts-recommended

• texlive-pstricks

• imagemagick

3.2.2 Compiling the User Guide

To compile the User Guide:

1. Configure the Nektar++ build tree as normal.

2. Run

   make user-guide-pdf

   to make the PDF version, or run

   make user-guide-html

   to make the HTML version.

3.2.3 Developers Guide

To compile the Developer’s Guide:

1. Configure the Nektar++ build tree as normal.

2. Run

   make developer-guide-pdf

   to make the PDF version, or run

   make developer-guide-html

   to make the HTML version.

3.2.4 Compiling the code documentation

To build the Doxygen documentation, the following dependencies are required:

• doxygen

• graphviz

To compile the code documentation enable the NEKTAR_BUILD_DOC option in the ccmake configuration tool.

You can then compile the HTML code documentation using:

make doc