Report which of the toolbox’s dependencies are present.
Source: src/utilities/environmentChecker.m
environmentChecker prints one report covering every
piece of software the MTI-Toolbox depends on, saying for each whether it
is available and what to do when it is not. Run it once after
installing: an incomplete environment shows up as a single list rather
than as a sequence of obscure errors discovered one at a time.
The report separates two classes of software, because they fail differently and have different remedies:
ver
and license
interfaces. These are licensed separately from MATLAB, and the toolbox
installer cannot add them — the packaging API has no way to declare a
required MathWorks product. The remedy is your license
administrator.which
— the same probe the runtime guards use. The remedy is usually a
download; for a kit bundled with the toolbox it is a reinstall, because
the kit ships inside the toolbox and can only be missing if it was
removed afterwards.For a MathWorks product the report distinguishes not installed from installed but no license available, because only the second is the license administrator’s to fix.
The categories — Required product, Gated capability, Demo prerequisite — and the software names are the canonical ones. The requirements page, the runtime guards and this report all use the same strings, so a guard message can be matched to the requirements table by reading it.
Bundling is not a category. The Sparse Grids MATLAB Kit ships inside the toolbox and is still a Gated capability: bundling says how the software reaches you, not whether the toolbox needs it. It is probed like any other kit, because a kit that shipped with the toolbox can still be deleted from the installation.
environmentChecker
report = environmentChecker()
report = environmentChecker(dependencies)
report = environmentChecker(___, Verbose=false)| Argument | Description |
|---|---|
dependencies |
(optional) struct array of manifest entries to report on.
Defaults to the toolbox’s own dependencies. Supply one to check a
subset, or software this toolbox does not itself require. Fields:
Software, Category, Provider
("MathWorks" or "Third party"),
Probe (a ver identifier for a MathWorks
product, a function name for a third-party kit), License
(license feature name, "" for a kit),
Capability, Source, Bundled
(logical; true for a kit redistributed inside the toolbox,
which changes the remedy from “download it” to “it was removed after
installation”). |
Verbose |
(optional, name-value) logical. Print the report. Default
true. |
| Argument | Description |
|---|---|
report |
table with one row per dependency and the columns
Software, Category, Provider,
Present, Status, Capability,
Remedy. |
Check the environment and read the report:
environmentCheckerMTI-Toolbox environment check
MATLAB R2025a (recommended release: R2025a)
MathWorks products
[ok] Optimization Toolbox Required product (present)
[MISSING] Symbolic Math Toolbox Gated capability (not installed)
needed for building models from strings or symbolic expressions, and
reading a model back as equations
Licensed separately by MathWorks. Ask your license administrator for
Symbolic Math Toolbox; the MTI-Toolbox installer cannot add it.
...
Third-party kits
[ok] Sparse Grids MATLAB Kit Gated capability (present)
1 of 7 dependencies are missing. See the remedies above.List only what is missing, without printing:
report = environmentChecker(Verbose=false);
missing = report(~report.Present, :)MyToolbox Documentation | Generated automatically by CI/CD pipeline