SDM-Doc

The SDM-Doc tool was developed by the Global Security Sciences Division at Argonne National Laboratory, and was inspired by Oliva’s (2002) work on HTML model documentation.

For a description of the tool and its purpose, see:

SDM-Doc is provided under a BSD open source license.

Two versions of the SDM-Doc tool are available:

  • The Java version (ver 1.2.89, June 1, 2017).
  • The .NET version (ver 5.0, Jul 23, 2014)

SDM-Doc/Java Version 1.2.89 (June 1, 2017)

The Java version provides a number of new enhancements to the original Java version 1.0. New capabilities include but not limited to:

  • Stock and Flow Diagrams are included
  • The model will be translated into pure Java
  • The model will be executed to generate thumbnail graphs of variable values (provided model is runnable)
  • Thumbnail variable value graphs can be included in report
  • Loop detection is enhanced to allow for time and number of loops limitations
  • Loop detection is enhanced to allow for automatic discovery of maximum loop length
  • Loop reporting is enhanced to include variable pair loops in common
  • Loop reporting is enhanced to include quick access to loop contents by variable

This point release contains a new feature as well as a few minor bug fixes for the previous version (version 1.2.71).

  • A new feature, visible on the main screen, allows the user to reuse saved data from a previous execution of the tool. This is primarily intended to be a time-saving feature. When working with large models, it is sometimes useful to repeatedly execute the tool while changing parameters such as the maximum loop size. Four types of data can be reused. These are the generated View images, the generated source code/classes, the thumbnail images of the results and the link polarities. In order to be a candidate for reuse, the modification time of the Vensim MDL file must be older than the creation/modification time of the generated files (i.e. the model cannot have been modified since the files were generated). The GUI widgets that control reuse will be disabled if not eligible for reuse. The output directory can be annotated with a time stamp and link size. Thus there can be multiple directories from which the filed could be reused. The user is given the capability to select from multiple output directories if they exist.
  • Fixed a bug in the delay functions that delayed the results of the function by 1 dt.

The software is distributed as a Zip file. Simply download the Zip file appropriate for you operating system and extract the files onto your computer. Executable scripts are provided for running the tool.

Download the Windows-specific 64 bit environment Zip file here.

Download the Windows-specific 32 bit environment Zip file here.

Download the Unix-specific Zip file here. Note that the Unix-specific Zip does not include jre.

Download the latest SDM-Doc/Java User Guide here Note: a new version will be available shortly.

Download the latest SDM-Doc/Java Source Code here.

Sample output generated by the SDM-Doc tool:

To provide feedback:

For more information:

Ignacio J. Martinez-Moyano, Ph.D.

Argonne National Laboratory

(630) 252-8824

imartinez@anl.gov