You are not logged in. Click here to log in.

Application Lifecycle Management
OMSConsole #24496/HEAD / v20
Tags:  not added yet

OMS Console

The OMS Console has three primary user interfaces: (1) simulation, (2) parameter editor, and (3) analysis output.
The OMS Modeling Console is a graphical user interface (GUI) for the OMS development platform. It provides simple access to core features, such as simulation management, output analysis, and documentation generation. Using the Console is just one way to interact with OMS. As open source software, modeling communities can integrate OMS system components into their own IDEs or custom model development applications.

The main purpose of the OMS Console is to allow a modeler a straightforward and simple tool to develop a model, create a simulation, run the simulation, provide for parameter editing and offer ad-hoc post run analysis and visualization. The figures below provide an overview of the OMS Console.

The Console's principal UI is shown in the figure above. Several buttons and layout features are familiar standard elements. The UI is organized as follows:

Working Directory

The working directory sets the base directory and system property oms3.work for a simulation. It defines a workspace for the simulation. If this folder contains the file oms3.conf, its content gets loaded and applied for all simulation. For example if the file oms3.conf contains a list of open files, they will be opened after setting this directory. The directory can be set using the button next to the directory name.

Simulation Tabs

Each tab contains one simulation script, tool bar, and associated console output. The console might have multiple simulations open at one time, however they must originate from the same workspace. Each simulation tabs operates independent from each other, means you can execute one simulation, while editing another one in a different tab.

Toolbars

The console has two tool bars. A global tool bar manages a set of simulations. In addition, each simulation has its own tool bar, allowing for different operations such as executing, documenting, etc. a simulation. The tool bar action are explained in detail below.

Editor

The simulation editor allows creating and editing a simulation file.

Console Output

This read only output area, shows all standard and error output from the simulation run. Users select the appropriate tab to view the output.

Status Line

Some informative message during console use.
Each simulation tab contains its own private tool bar. The tool bar actions are always directed towards the current simulation script in the editor.

OMS Toolbar buttons are described as follows:


  1. Create a new, empty simulation.
  2. Open an existing simulation from <working directory>/simulations.
  3. Save all open simulations.
  4. Select options and settings (show hidden files, folders; clear output before next run)
  5. Create a new project (currently inactive)
  6. Close current project
  7. Open project
  8. Save simulation script to a file. If the file is new, it will prompt for a name.
  9. Run the simulation script.
  10. Interrupt and stop a running simulation. If no simulation is running this button is disabled.
  11. Open the Parameter Editor loading referenced parameter files from the current simulation. The Parameter Editor is explained in a section below.
  12. Open the Analysis Output window. The window will open if a simulation specifying analysis has run. The analysis window is explained in more detail below.
  13. Generate Docbook5 documentation of the simulation and store it into the project output folder.
  14. Clean and build the model. This is an alternative to doing this in Netbeans or the IDE being used.
  15. Open the last output folder using the computer operating system file explorer.
  16. Clear the console output for this simulation.
  17. Set logging level for the simulation. This will result in more or less verbose output during simulation execution.
  18. (Not shown) Create a SHA digital signature of the simulation and print the simulation fingerprint to the Analysis Output Window.

Each tab has a context menu that is accessible with a right mouse click. It allows saving, saving under a different name, closing, and other operations with respect to the selected tab.

OMS Console - Parameter Editor

The Parameter Editor is a visual tool for parameter editing that is embedded in the OMS console. It can be started by clicking on the appropriate button in the tool bar of a simulation tab. It allows for a presentation and filtering of parameter values, bulk editing of values, statistics, and basic spread sheet like operations.

The editor works on parameter files that adhere to the OMS CSV parameter file format. Such files can be easily edited with other external tools such as Excel, however the parameter editor provides an easy to use interface to manipulate parameter values numerically.

Note that only parameter files referenced as properties in the model parameter sub-element in a simulation using the .. parameter(file:'<name>') ... construct can be loaded into the Parameter Editor. Parameters and parameter files referenced as sub-elements of the parameter sub-element, that is, contained within curly brackets "{...}" cannot be loaded into the Parameter Editor.

The figure above shows the Parameter Editor with loaded parameters. The layout of the window is organized as follows.

Parameter File

This combo box shows the active parameter file for editing. When opened the combo box lists all parameter files as specified within parentheses of the parameter sub-element. The modeler should select the parameter file to view and edit.

Filter

The Filter combo box allows switching views on the parameters in the selected file. They can be filtered by dimension, by scalars, or all parameters can be presented as shown in this figure. Changing the filter will cause different parameters sets to diplay in the Parameter Editor panel.

Command Console

The command line on this console allows the (bulk) manipulation of parameter data. This command line has a history, a help function and offers more powerful methods of editing parameter values. This will be demonstrated in more detail during the workshop.

Parameter Editor Panel

This table shows the parameter names and values. The layout might change when different filter are applied. It has in-place editing capabilities, by clicking on a cell, it value can be edited and changed.

The figure above shows the parameter editor with an applied dimension filter. The table presents all parameters bound to a specific dimension. Selecting cells in the table will print basic statistics about those on the bottom of the window. Any area can be selected, a column selection will print statistics about the whole column at the bottom of the editor.

OMS Console - Analysis Output

The Analysis Output window graphically displays output defined in the analysis section of a simulation. It is executed by pressing the Analysis Button in the tool bar in a simulation tab. The following graphic shows a time series plot of simulated streamflow (red), observed runoff (green), and the difference between the simulated and observed values.

The tile bar shows the output folder containing the analysis data. Depending on the setting in <outputstrategy>, such output can be versioned or unversioned. With either setting, the last output folder of a simulation run is presented.

The analysis tabs contain the plots, graphs, and charts, such as timeseries, error, scatter, flowduration, and other analyses. The tab name reflects the analysis performed.

A part of the analysis section used to create the plots above is shown below.

...
analysis(title:"Simulation Output") {
    timeseries(title:"East Fork Carson", view: COMBINED) {
        x(file:"%last/out1.csv", column:"date")
        y(file:"%last/out1.csv", column:"basin_cfs")
        calc(eq:"simulated - observed") {
             simulated(file:"%last/out1.csv", column:"basin_cfs")
             observed(file:"%last/out1.csv", column:"runoff[0]")
        }
        y(file:"%last/out1.csv", column:"runoff[0]")
    }
     timeseries(title:"Error", view: MULTI ) {
...

Note the timeseries sub-element of analysis maps to the view of the plot graph above. Note the variable %last references the last output folder of a simulation run. The plot contains three y axes, one of which involves the calculation of simulated minus observed values.

To reiterate, the Analysis Output window displays graphics only if the analysis DSL element is specified in the simulation file.