MBDlyb user guide

MBDlyb-UI is the web interface of MBDlyb, a prototype Python library for design-driven, model-based diagnostics developed by TNO-ESI. With the interface you build a functional model of a system, enrich it with diagnostic information, check it, and use it to:

• diagnose a malfunctioning system by entering observations and test results, and get suggestions for the next most informative test (the The diagnoser);

• analyse the diagnosability of a design and derive diagnostic procedures before the system is built (Design for diagnostics).

Fig. 1 The model editor showing the root cluster of the CDRadioPlayer example model.

This guide focuses on using the front-end and on understanding what is being modelled. All screenshots show the CDRadioPlayer example model, which you can download and load yourself (see Introduction).

Getting started

• Introduction
  • Why model-based diagnostics?
  • The methodology
  • Example projects
  • Contact
• Installation and start-up
  • Requirements
  • Installing the interface
  • Setting up Neo4j
  • Importing and exporting databases
  • Starting the interface
• Tutorial: exploring the CD radio player
  • 1. Load the example
  • 2. The system and its structure
  • 3. Functions and their dependencies
  • 4. Operating modes
  • 5. Faults and custom states
  • 6. Observations and tests
  • 7. Check the model
  • 8. Diagnose a failure
  • 9. Analyse the design
  • Next steps
• Tutorial: building a model from scratch
  • 1. Create the model
  • 2. CD reader and radio receiver
  • 3. Audio system
  • 4. Power system
  • 5. Check the model
  • 6. Diagnose a failure
  • Next steps

Understanding the model

• What is being modelled
  • Overview
  • Model elements
  • Relations
  • States and conditional probability tables
  • From model to reasoning

Using the interface

• The interface
  • Layout
  • Editor mode and Tree mode
  • The cluster toolbar
  • Tables
  • Settings
• Building and editing models
  • Common principles
  • Clusters
  • Functions
  • Hardware
  • Observables
  • Diagnostic tests and test results
  • Operating mode selectors
• Conditional probability tables
  • When you need a custom CPT
  • Where to find the CPT buttons
  • The CPT editor
  • Exporting and importing CPTs
• Modelling in Capella
  • Importing a Capella model
  • Diagnostic annotations
• Importing and exporting
  • Importing a Capella model
  • Downloading the graph and Bayesian network
  • CPTs
  • Diagnosis results
• Checking a model
• The diagnoser
  • Starting the diagnoser
  • The page layout
  • Entering evidence
  • Evidence
  • Walkthrough: the CD player does not play
  • How tests are ranked
  • Soft evidence
• Design for diagnostics
  • Running the analysis
  • Signatures
  • Diagnostic procedures
  • Overview

Reference

• Glossary
• Maintaining this documentation

Developer reference

• mbdlyb
  • Submodules
• mbdlyb_ui
  • Submodules