SplashTool is now being used regularly within Dahlem. Furthermore, it’s being used in Kaiserslautern as a tool for area-wide analysis. Up until now, comments in the source code and brief, unsorted explanations of the algorithm have been enough for documenting the functionality.
This is no longer adequate because both the underlying methodology and the application are now of interest to people beyond those with prior Python knowledge: We need a documentation.
I’ve decided to dust off my somewhat rusty LaTeX skills, use it to create the documentation, and manage the LaTeX source files alongside the model source code in git. The basic structure is in place, and the chapters will be filled with content over the next few weeks.
Update from October 4th: The documentation is now online and can be downloaded here.