Tool Description Template - openETCS/model-evaluation GitHub Wiki
Presentation
Tool name
Website (if available)
Contact email
i.e. to someone that has authority to answer questions on this tool and that can answer promptly; it can be an alias
Main usage:
- Modelling
- Code generation
- Test case generation
- Model verification
- Code verification
- Other (Please elaborate)
Summary
Brief introduction to what the tool does
Publications
short list (max. 2) of publications related to the tool with a URL to download a copy. If possible a tutorial/user guide to the tool and/or the languages it is based on + reference document
Support and Survivability
Which kind of support is provided? Commercial support through a company, community support through a mailing list, both, other? Pricing.
Is the tool likely to exist in 10 years? Is it supported by a strong company that can fix potential bugs in the tool?
Applicability
Key capabilities
Input (which languages are targeted?)
Output (Proof, code, other)
Main restrictions
e.g. only a subset of the target language is covered
Manual or automated use of the tool
e.g. which steps are manual and automatic in the use of the tool.
Expertise level
e.g. which prerequisite is needed to use the tool
Integration in the tool chain and development process
Currently distributed: Yes/No
Underlying technologies
E.g. Framework, .NET vs. Java, etc.
Describe requirement to install/run the tool (all that is necessary to make the tool work fine: OS, Java version, dependencies with other tools, Eclipse version, ...)
Traceability
Industrials need to maintain some traceability between source documents and deliverables, for certification purposes, as well as for maintenance and evolution purposes. Does the tool provide such traceability, or does it integrate in such a way that the traceability is maintained in a satisfactory way (notably WRT CENELEC requirements)?
Team work:
can the tool be used by a team working on different fragments of the model? is there a support for versioning?
Certification issues:
can the tool be used in a SIL-rated development process? There is a mention of this in the "Existing industrial usage" section, but I suggest to put it as a top-level item in the template.
For instance: are the underlying assumptions of the model acceptable WRT the development of systems evolving in real physical environment? This might not be the case if we consider models with a discrete (tic-based) model of time.
Participants
People or parties who have developed this and are currently driving the project including their affiliations
Stable or recommended version of the tool
If different, version of the tool that should be used for the project
Tool available for openETCS participants?
If yes, Under which licence?
If no, or not under an Open Source licence, are there plan to do it?
Licenses of underlying technologies
Eclipse interface
Other integration possibilities
Existing industrial usage
Especially if the tool has been qualified for CENELEC 50128 or other (DO-178)
List of projects or toolboxes (only list the representative examples) where the tool has been integrated + some information on the toolchain architecture that has been used (e.g. Eclipse Modelling / OSGi / UML / ...).
Planned development
All further developments that are relevant for openETCS, even if not conducted directly within the project.