This area of the web site provides detailed reference documentation that has been automatically derived from the source code. For introductory information and advanced guidance, see Documentation Overview.
The SKIRT reference material includes detailed documentation for every class, namespace, function, and macro defined in the SKIRT C++ code. The following entry points into the documentation are provided:
Note that namespaces are listed separately and thus are not included in the class index and list. This can be confusing because a set of related "static" functions could be implemented as a namespace (e.g., SpecialFunctions) or as a class (e.g., NR), requiring the user to look for the entity in two lists.
The ski file reference material comes in very handy when manually adjusting a ski file. It includes two (long) pages:
The Python Toolkit for SKIRT (PTS) reference material includes detailed documentation for every package, class and function defined in the PTS Python code. There is a single entry point into the documentation: