7. Plugins Must Provide Metadata

  • Status: [accepted]

  • Deciders: [Fabian Bühler]

  • Date: [2021-06-29]

7.1. Context and Problem Statement

In order for QHAna to use the plugins and present them to the user in a meaningful manner the plugins must provide some form of metadata describing themselves.

7.2. Decision Drivers

  • QHAna must present the plugins to the user (ideally only relevant plugins for the current experiment state)

7.3. Considered Options

  • No Metadata

  • Unstructured Metadata

  • Structured Metadata

7.4. Decision Outcome

Chosen option: “Structured Metadata”, because this allows for some decisions (e.g. plugin grouping or checking if plugin can be used with certain inputs) to be automatically checked greatly enhancing the user experience.

The exact metadata format is to be defined in the documentation.

7.4.1. Positive Consequences

  • Some decisions can be automated

  • Better user experience

  • Not much effort for plugins (compared to unstructured metadata)

7.4.2. Negative Consequences

  • Plugins must provide valid metadata to work correctly with QHAna