Nektar++

Downloads

Compilation Instructions
   Linux
   Windows
   Mac OS X
   Unit Tests
   Regression Tests
   Documentation

Example Usage

Educational Material

Documentation

Team Members

Publications

License

Acknowledgments

Contact

Generate Doxygen Documentation


Nektar++ uses the documentation system Doxygen for generating documentation. The Doxygen HTML files are not included in the tarball because the size prohibits it. To generate the full documentation, follow the steps below:

  1. Required packages
    • Doxygen
      If you do not have Doxygen installed, you may obtain it from http://www.stack.nl/~dimitri/doxygen/. The web site also offers a manual for installation on both Windows and Unix.
    • Graphviz Dot
      The dot program in the Graphviz package is also recommended. Having dot allows for the creation of graph diagrams at the top of the HTML pages. You may obtain it from http://www.graphviz.org/Download..php. Once installed, make sure the Graphviz's bin directory is in your path, so Doxygen can see the programs.
    • LaTeX
      LaTeX is also a recommended program that may be installed with your Unix distribution's package manager. The LaTeX web site is at http://www.latex-project.org/. A common Windows TeX package is called MiKTeX and can be downloaded from http://miktex.org/. After installation, make sure it is in your path so Doxygen can use it. Doxygen uses LaTeX to generate PNG images for the website.
  2. Doxygen instructions
    • Windows
      • From the icon group that the Doxygen installation created, run the Doxywizard program.
      • Press the "Load" button and choose the Nektar++/docs/html/doxygen/doxygen file.
      • Press the "Start" button and wait until the HTML generation completes.
    • Unix
      • Navigate to the Nektar++/docs/html/doxygen/ from the terminal.
      • Execute the command
        doxygen ./doxygen
        to start documentation generation, and wait until it completes.
  3. Open Nektar++/docs/html/code/index.html with your web browser to view the full Nektar++ doxygen documentation.
The Doxyen documenation has been generated with Doxygen 1.7.1 which is the recommended version.