Module Reference

../_images/module_organization.svg

The fmdtools package is split into three subpackages for design, simulation, and analysis. As shown above:

  • The fmdtools.define subpackage provides classes for model and simulation definition, and is used for defining system (nominal and faulty) behavior.

  • The fmdtools.sim subpackage provides functions to simulate these models in a variety of configurations (e.g., nominal and faulty scenarios).

  • The fmdtools.analyze subpackage provides classes for processing, analyzing, and visualizing simulation results.

Thus, working with fmdtools often means creating a model file which extends classes from fmdtools.define, and then simulating and analyzing that model in a script or notebook using the fmdtools.sim and fmdtools.analyze subpackages. This page provides references for the functions and classes in these modules.

Submodule Links