The GunnShow User’s Guide in a new GUNNS install only has partial content and must be built to generate the full content, including Doxygen comments, class diagrams & code listings, etc. To build your user’s guide, you first need the Doxygen applications (see here for GUNNS Dependencies).

To build the guide, follow these steps:

• First, make sure you are in the GUNNS environment . This sets the $GUNNS_HOME environment variable to your gunns/ folder, which the following Doxygen build steps require.

• Do this command to find the Doxygen application on your system:
  

  $ which doxygen

• If you have Doxygen, this will output a < doxygen path > which you’ll use below, such as:
  

  /usr/bin/doxygen

• Change directories into your gunns/gunnshow/doxygen folder.
• Run:
  

  $ < doxygen path > GsDoxConfig.txt

• Allow 1-2 hours for it to build. It takes a long time because we haven’t cleaned it out in a while. Hopefully we can do that soon!