Skip to content

Conversion tools: What we want to know

cabo edited this page May 11, 2021 · 2 revisions

Various conversion tools are now available, often open source. What do we want/need to know in order to be able to assess their usefulness?

This is a small checklist for a potential presentation on a conversion tool, or a piece of documentation that serves as a tutorial.

As people may not be fluent in the other format, we should probably start with:

(1) quick presentation of the other format

This of course focuses on what is interesting in the context of conversion, and one specific focus might be:

(2) discussion of where the other format differs in its expressibility

Where can SDF tell more? Where can the other format tell more? Is round-tripping even something that could be aimed for?

To get more of an impression of how the conversion works, we'd then move to a "demo", which of course is less about calling the tool and seeing the command line, but about input and output for specific examples in comparison:

(3) set of examples (fragments of models)

This says "fragments" because it will often not be possible to cover all of several possibly substantial examples.

It is also probably worth to cover:

(0) practical use of the tool, getting started, etc.

Clone this wiki locally