Structure of IDEAS documentation:
Description
Description of components, equations, reference links (references should be written
in the user's Guide of the library)
Assumptions and limitations
(keep this section short and to the point, preferentially in bullets only)
- Description of assumptions used by the model (including tuned parameters which should not be modified by the user).
- Description of the validity region of the model and interval of accuracy (if possible)
Model use
- Which are the important, the tuning and the "negligeable" parameters.
- What are the default value of the model and how have then been chosen.
Validation
Description of the validation procedure and results
Example (optional)
Link to an example for the component and (optional) examples where the component is used.
Revision, history and contact
- 2013 May 9, Picard Damien,
Addition of Validation paragraph.
- 2013 May 9, Picard Damien,
First implementation.