This page and its sub-pages presents some information related to the previous OMF 5.2 release
Please visit the pages linked from the Main User Guide page for the documentation on the latest OMF version
OEDL - The OMF Experiment Description Language¶
OMF defines and uses a Domain-specific Language to describe an experiment. This language is named OEDL for 'OMF Experiment Description Language'.
OEDL provides a set of specific OMF commands and statements, and is based on the Ruby language. As a new user you do not need to know Ruby to write experiment description with OEDL. You can get started with only some basic OEDL commands and syntax, as shown in the Basic set of Tutorials. However, you will need to have some general entry-level programming knowledge.
As explained in the Usage Overview page, an OMF Experiment Description (ED) is composed of 2 parts in the following order:
- Resource Requirements & Configuration: this part enumerates the different resources that are required by the experiment, and describes the different configuration that need to be applied on them
- Task Description: this part is essentially a state-machine, which enumerates the different tasks to perform with the required resources in order to realize the experiment
This page provides a detailed description of the OEDL commands. These commands can be grouped in the following categories:
Some of these commands also provide a list of sub-commands. These sub-commands will only be usable when associated with the parent command. In such case, the description page of the parent commands will contain the details of the sub-commands.
Notes:
In these pages, "Experiment Script" may also be used to refer to "Experiment Description"
Please refer to the Minor Caveats page to learn about minor known issue of this documentation