Standards

The ready4 software framework has been designed to implement computational models that meet explicit standards of transparency, reusability and updatability.

A key motivation for the ready4 software framework is standardisation. Defining and adhering to a common set of standards is important because:

The ready4 software framework supports implementations of computational models that are transparent, reusable and updatable.

Transparent

Model code and data are publicly available in online code repositories and data collections. Algorithms are documented and transparently and regularly tested. Model development occurs in the open and invites community participation, with each individual’s contribution publicly identifiable. Analyses are reproducible and replicable.

Reusable

Model modules and datasets originally developed in one modelling project can be independently reused in other projects. As they share a common framework, model modules can be combined in other models and analyses to address multiple topics. Due to ready4’s code implementation paradigms, model modules are easier to transfer for use in other decision contexts.

Updatable

Model code, data and analyses are versioned, with an ongoing program of making new and updated releases. Software is maintained, with opportunities for users and contributors to flag issues, request features and supply code contributions.

Our criteria for assessing transparent, reusable and updatable implementation of computational models are described in a manuscript being prepared for publication.

Last modified April 27, 2023: reorganisation of docs (82bfadf)