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.

SKIRT Reference

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:

Class Index: a compact, multi-column list of all classes.
Class Hierarchy: the inheritance trees for all classes.
Class List: a single-column list of all classes.
Namespace List: a list of all namespaces.
Macro List: a list of header files defining macros.

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.

Ski File Reference

The ski file reference material comes in very handy when manually adjusting a ski file. It includes two (long) pages:

List of subclasses for each base class: for each base class that may occur in a ski file, a list of available subclasses.
List of properties for each concrete class: for each concrete class that may occur in a ski file, a list of supported properties including those inherited from super classes.

PTS Reference

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:

PTS Reference: a hierarchical list of packages, classes, and functions. Click on a triangle to open or close a node in the hierarchy.