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.44, June 15, 2016).
  • The .NET version (ver 5.0, Jul 23, 2014)

SDM-Doc/Java Version 1.2.44 (June 15, 2016)

The latest 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 release contains two new data reports a few minor bug fixes for the previous version (version 1.2.39) including:

  • a count of the number of different units used in the model (basic and combined)
  • a table listing all units, the type, and any equivalent alternates used
  • a count of the number of Rate-to-rate links
  • a table containing the hyper-linked variables in all Rate-to-rate links

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 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