Skip to content
Kermin E Fleming edited this page Feb 15, 2015 · 2 revisions

Apm-edit

The program apm-edit is used to modify a model.

Invoking apm-edit

Apm-edit operates on invoking apm-edits and can be invoked from the command line or from the awb GUI. See apm-edit invoking for an example.

Module tree view in apm-edit

Once opened, apm-edit shows the module hierarchy tree for the model. In that tree, each node contains a specific implementation of a module with the needed awb-type (as specified by the %provides directive in the module’s .awb file) and has children of the awb-types specified in that module’s %requires directives in its .awb file.

Apm-edit allows one to easily replace a module with any alternative module that %provides the proper awb-type. When one selects a module in the module tree one can see in the lower left pane the ‘Alternative Modules’ portion of the dialog that shows those alternatives. Double clicking on a alternative will replace it in the model. If you don’t see a module you expect then you can refresh the module database by clicking on the ‘REFRESH’ button.

Information about the currently selected module is displayed in the lower right pane. Different tabs in that pane show different pieces of information about the module (all derived from the module’s .awb file.

  • View pane
    • Summary – a summary of the module including the package containing the module, its name and attributes and the awb-type that the module requires and provides.
    • Files – the directory containing the files that implement a module and the names of the individual files that comprise the module
    • Parameters – the parameters (both dynamic and static) that can be set for this module
    • Notes – the contents of the notes file specified in the module’s .awb file
      h3. Submodels

Modules denoted by a ‘double gear’ are submodels that are represented in another .apm file, rather then an .awb file. These submodel .apm files contain a complete module hierarchy. The root module in those .apm files, however, will be of the awb-type of the module required by the node.

One can create a submodel by right clicking on a node in an exisiting module tree and selecting ‘insert as root’ and saving the new file as a submodel. By convention submodels are saved in a directory under config/pm. A ‘REFRESH’ is required to view newly saved submodels in the ‘Alternative Modules’ window.

Creating and saving models with apm-edit

Creating a new model is probably most easily accomplished by modifying an existing model and using the ‘File→SaveAs’ menu operation. One can, however, use the ‘File→New’ menu in apm-edit to create a new model – see new model example. Saving a model is done using the conventional ‘File→Save’ menu operation.

Building and running a model from apm-edit

One can use the ‘Model’ menu in apm-edit to configure/build/setup/run a benchmark on a model – see apm-edit example.

Cog color legend

apm-edit uses colors on the little cog icons next to a module’s name to indicate a notion of matching and default modules. This determination is based on the attributes of the model and module. A alternative is marked as matching if any of its attributes match those desired by the model. It is marked as the default if it is the best match as determined by the module matching algorithm.

Grey – Generic (non-matching/non-default) modules
Yellow – The default alternative module for this spot in the model
Blue – One of the matching modules for this spot in the model
Red – No module has been selected for this spot in the model yet.

Clone this wiki locally