Model apps

How a CVDLINK model is packaged.

Status of this page

To be filled.

This page will describe how an analysis or model is prepared so that it can be distributed to participating sites and executed there.

Intended contents

What a model app is. The unit that is distributed and run, and what it contains.

Packaging. The image or archive format, how it is built, and the structure expected inside it.

The interface a model must implement. The entry point, the states a run passes through, and how the app signals that its part is complete.

Input. Where the app finds the site's prepared dataset, in what format, and what it may assume about its contents.

Output. What the app produces, where it writes results, and which of those leave the site.

Configuration. How parameters are supplied to a run, and which may differ between sites.

Local testing. How to run an app against a single site's data before distributing it, so that failures are found before a federated run.

Distribution. Where apps are published, how a site obtains one, and how versions are identified.

Review. What is checked before an app is accepted for a federated run, given that it executes against patient data at every participating site.