OpenMS GUI documentation

The graphical tools of OpenMS and the library they are built on, OpenMS_GUI. They are developed in the repository OpenMS-TOPP-GUI and are built and installed on top of an OpenMS installation of the same version (the OpenMS library, the TOPP tools and the shared data come from there).

All aspects of using OpenMS (installation, workflows, user tutorials, including those for TOPPView) are described on the OpenMS ReadTheDocs website. The documentation of the OpenMS library and of all other TOPP tools is the OpenMS API reference (nightly).

Graphical tools

• TOPPView - visualization and analysis of MS data
• TOPPAS - design and execution of TOPP workflows
• INIFileEditor - editor for the parameter (INI) files of TOPP tools

TOPP tools that need the GUI library

• ExecutePipeline - runs TOPPAS workflows on the command line
• ImageCreator - writes an LC-MS map as an image

Tutorials

• TOPPAS tutorial
• Developing the GUI layer

The GUI library

The classes of the GUI library are grouped in the module Visual (see also the class list). The code examples in doc/code_examples/Tutorial_GUI_*.cpp show how to use some of the widgets in an application of your own.