Aarhus Universitet
You are here: Animals and plants » ALMaSS » Documentation

Model documentation

The documentation presented has been implemented by using the ODdox protocol.ODdox provides a model overview together with the capability of viewing and navigating through the source code in an efficient and manageable manner. A major advantage is that connections between objects, methods and functions are hyperlinked and can therefore be followed easily together with the source code, even without more than a very basic understanding of programming.

The documentation presented has been implemented by using the ODdox (Overview Design doxygen) protocol (Topping et al, 2009). This protocol provides a model overview with the capability of viewing and navigating through the source code in an efficient and manageable manner. A major advantage is that connections between objects, methods and functions are hyperlinked and can therefore be followed easily together with the source code, even without more than a very basic understanding of programming.

ODdox also facilitates the communication of complex models built from object oriented code by providing documentation based on the class structure of the model itself, and using doxygen (http://www.doxygen.org) to extract code comments and structure directly from the source code used to run the model..

Documentation:

The current version of the overall ALMaSS ODdox

Carabid beetle (Bembidion lampros)

European brown hare

Field Vole

Grey partridge (Perdix perdix)

Skylark (Alauda arvensis)

Comments on content: 

Revised 07.02.2012