Model documentation template - openETCS/model-evaluation GitHub Wiki

Introduction

This template describes the structure that should follow the documentation associated to a model for model evaluation.

Template

  1. Short introduction to the used formalism and tool
  2. Modelling Strategy
    • short explanation of the point of view of the model
  3. Model Overview
    • short explanation of the model structure
  4. Model Benefits
    • benefits from using this modeling formalism for the case study
  5. Detailed Model Description

Latex Template

The following file is a latex file for the proposed structure: https://github.com/openETCS/model-evaluation/blob/master/model/templates/description_template.tex