The Ergo source code contains doxygen-style comments. To generate documentation simply execute the command "doxygen". Then documentation in HTML format will be generated in the directory documentation/html. You can then view the documentation by opening documentation/html/index.html in a web browser.

Command-line help

Once you have compiled the Ergo executable, just type "./ergo -h" for a listing of all available input parameters, or "./ergo -d parameter_name" for a description of a specific input parameter.


Further information is available under the Ergo project's Trac pages, available here:

On the Trac pages you can track reported issues such as bug reports and suggested improvements. The Trac pages also include user-generated documentation in wiki form. If you want to contribute by reporting your own issues and/or add to the wiki pages, send an email to info(at) and we will send you login information.


Examples on how to use the Ergo program are available on our tutorial pages.