Chapter 1. Introduction to ToolRunner

Table of Contents

1.1. What is ToolRunner?
1.1.1. ToolRunner Features and Utilities
1.1.2. How ToolRunner Finds Packages
1.2. Starting ToolRunner
1.2.1. Windows
1.2.2. macOS
1.3. The ToolRunner GUI
1.3.1. FileList Area
1.3.2. Execution Area
1.4. Using ToolRunner
1.4.1. Add Files
1.4.2. Run the Process
1.4.3. Check Results

1.1. What is ToolRunner?

ToolRunner is a meta tool to

  • via .mldoc files, build documentation based on Doxygen or Docbook.

  • via .mlinstall files, build an installer for compiled sources (requires an MeVisLab ADK licence).

ToolRunner is available for all supported platforms but the options may differ.

1.1.1. ToolRunner Features and Utilities

Basically, ToolRunner handles a lot of scripts. In addition, however, it offers supporting features and utilities like

  • an easy-to-use file list, see File menu,

  • a Tools Check utility, see Tools Check,

  • a Package Manager for checking whether the packages are "visible" to the tools, see Package Manager

  • license creation (needs the MeVisLab ADK).

1.1.2. How ToolRunner Finds Packages

ToolRunner typically works on MeVisLab packages but can be used for any supported file type. It checks for available packages in the same way as MeVisLab

  • the directories given in the PackagePaths settings of mevislab.prefs.

  • the Packages directory in which MeVisLab was installed.

  • the UserPackagePath (as set in the MeVisLab Preferences dialog)

[Note]Note

Packages installed with MeVisLab are usually not offered in ToolRunner dialogs as they do not contain sources.