wiki:workbench_documentation_template

Version 1 (modified by gkronber, 13 years ago) (diff)

copied page from private trac

Copy the text in this box

= Title =
== Description ==
Provide here the purpose and/or idea of this workbench

== Parameters ==
  * Problem
    * Setting = value
  * Algorithm
    * Setting = value
    * ...

== Implementation & Notes ==
If you know it, please specify the revision of the repository which was used to build the framework and algorithm using the r + revision number syntax and any tickets using the # + ticket number syntax which are related to the workbench.
Additionally write notes regarding the parameters or give implementation specific details

== Results & Conclusions ==
Results from one or more testruns

== Files ==
Link to the workbench and any other files in the repository which you want included here
----

This will look like following:

Title

Description

Provide here the purpose and/or idea of this workbench

Parameters

  • Problem
    • Setting = value
  • Algorithm
    • Setting = value
    • Setting:
      • Subsetting = value
      • ...
    • ...

Implementation & Notes

If you know it, please specify the revision of the repository which was used to build the framework and algorithm using the r + revision number syntax and any tickets using the # + ticket number syntax which are related to the workbench. Additionally write notes regarding the parameters or give implementation specific details

Results & Conclusions

Results from one or more testruns

Files

Link to the workbench and any other files in the repository which you want included here