Miscellaneous: Documentation

MOSAICmodeling has been developed with the aim of linking modeling and simulation with the documentation of the model. This aim is supported by the documentation feature.


The documentation feature allows the user to automatically generate LaTeX code based on any of the MOSAICmodeling elements. This means that you can directly export your model after you have completed your simulations, e.g., because you want to publish the model, use it in your thesis, etc.

Explanation of the editor

The documentation feature is shown below in Figure 1. Basically, you select the model element you want to export, e.g., an equation, an equation system, a variable specification, or a simulation. Afterwards, you set the type of export (see Table 1), and copy the code into your LaTeX document.

Figure: Documentation feature of MOSAICmodeling.
LocationFile you want to export, i.e., equation, equation system, simulation, etc.
OptionAllows the user specific options, e.g., whether generic or instantiated equations shall be exported
Export selectionDepends on the type of the loaded MOSAICmodeling element. In the case of a simulation, the user can select which part of the simulation shall be exported – all files or only a specific element, such as the equation system
LaTex styleAllows the selection of a couple of different export types, e.g., framed equations.
GenerateGenerates the LaTeX code according to the set options
Table 1: Elements of the documentation feature.