How to Install Modality

# For Linux

  1. If you haven't already, request a trial version of Modality. (opens new window) Auxon will email you a Modality license key.

  2. Download Modality for Linux. (opens new window)

  3. Go to your download folder in the terminal and run
    sudo apt install ./modality_<version>_<arch>.deb.

    • After reading the EULA, press tab and then enter twice to accept and install Modality.
  4. Run modality config --license-key <license-key> --email <email-address>, where <license-key> is the Modality license key emailed to you by Auxon, and <email-address> is the email address where you received that license key.

  5. To confirm that Modality installed correctly, run modality sut list and then modality session list. You should see the following results.

$ modality sut list
  NAME         COMPONENTS  SESSIONS
  example-sut  4           1

  $ modality session list
  NAME             SUT          STATUS
  example-session  example-sut  CLOSED
  1. If the above commands do not work, check the status of the Modality daemon with sudo systemctl status modalityd.

  2. Completing these steps has done the following:

    1. Commands: Installed the modality and modality-probe commands.
    2. Service: Started the modalityd systemd service, Modality's planning and analysis daemon.
    3. Database: Installed data in the Modality database for an example system under test.
    4. Example system: Installed the source code for the example system under test at directory /usr/share/doc/modality/examples/c-example
    5. Configuration: Created a Modality configuration file at /home/$USER/.config/Modality.toml.
  3. Next steps:

    1. Most users move straight to analysis and troubleshooting; see How to Collect Session Data and Using Modality.
    2. To instrument your embedded system, see How to Instrument Your System.

# For Windows

  1. If you haven't already, request a trial version of Modality. (opens new window) Auxon will email you a Modality license key.

  2. Download Modality for Windows. (opens new window)

  3. Go to your download folder and run modality-<version>-x86_64.msi

    • Read and then accept the EULA to install Modality.
  4. Run modality config --license-key <license-key> --email <email-address>, where <license-key> is the Modality license key emailed to you by Auxon, and <email-address> is the email address where you received that license key.

  5. To confirm that Modality installed correctly, open up PowerShell. Run modality sut list and then modality session list. You should see the following results.

PS C:\> modality sut list
  NAME         COMPONENTS  SESSIONS
  example-sut  4           1

  PS C:\> modality session list
  NAME             SUT          STATUS
  example-session  example-sut  CLOSED
  1. Completing these steps has done the following:

    1. Commands: Installed the modality and modality-probe commands.
    2. Service: Started the modalityd service, Modality's planning and analysis daemon.
    3. Database: Installed data in the Modality database for an example system under test.
    4. Example system: Installed the source code for the example system under test.
    5. Configuration: Created a Modality configuration file at C:\Users\$USER\AppData\Roaming\Modality.toml.
  2. Next steps:

    1. Most users move straight to analysis and troubleshooting; see How to Collect Session Data and Using Modality.
    2. To instrument your embedded system, see How to Instrument Your System.

# Docker

Modality provides a set of Docker containers for CI and other applications; see the Docker Integrations reference guide for details.

# Tarball

The Modality Download page (opens new window) offers a .tar.gz package that contains Modality's Instrumentation SDK, CLI, modalityd daemon, example systems, and more.

.
├── bin
│   ├── modality
│   ├── modalityd
│   └── modality-probe
├── CHANGELOG.md
├── cmake
├── completions
├── examples
│   ├── c-example
│   └── rust-example
├── include
│   └── modality
├── lib
├── LICENSE
├── man1
├── rust
└── VERSION

# Updating Modality

  1. Call modality --version to see the version of Modality installed on your system.

  2. Visit the download page for Modality. (opens new window) If there's a new version, download it.

  3. Go to your download folder and install the new Modality package:

    • Call sudo apt install ./modality_<version>_<arch>.deb for Linux.
    • Run modality-<version>-x86_64.msi for Windows.
  4. There's no need to uninstall previous versions of Modality between updates.