Ompp UI User Interface
Open++ user interface (ompp-ui) is a lightweight web UI which is:
- scalable: can be run on single end-user desktop and in cluster environment
- cloud ready: can be deployed in private or public cloud (Amazon AWS, Microsoft Azure, Google Cloud, etc.)
- portable: work on Windows, Linux and MacOS, 32 and 64 bit versions
- open source: it is open source product
By default ompp-ui does not require any installation, to run it do one of the following:
- on Windows double click on
bin\ompp_ui.bat - on Linux double click on
bin/ompp_ui.sh - on MacOS double click on
bin/ompp_ui.command
Any of above script is relatively simple, all it does is starting oms web-service:
cd ~/openmpp_mac_20200704
bin/oms
.....
2020-06-19 16:07:57.892 Model directory: models/bin
2020-06-19 16:07:57.930 Listen at localhost:4040
2020-06-19 16:07:57.930 To start open in your browser: localhost:4040
2020-06-19 16:07:57.931 To finish press Ctrl+C
and open your browser at http://localhost:4040
It is also possible to run the model and open UI from IDE:
- Visual Studio, details at Windows: Create and Debug Models
- Visual Studio Code, details at Linux: Create and Debug Models
- Xcode, details at MacOS: Create and Debug Models
Current openM++ UI status: beta version of UI suitable for single user.
OpenM++ UI is an advanced beta which incorporates significant portions of core required UI functionality, but which is missing others. The underlying software architecture is modern and layered, to make it easy to change or evolve the UI. Lower layers of openM++ contain functionality (eg run import and export, result export, distributed cloud execution) which is not yet exposed or accessible in the current UI.
Your feedback on the openM++ UI is welcomed. Please feel free to join and participate in discussion of the openM++ UI on GitHub.
To open UI from Visual Studio solution model build change project settings as on screenshot below. Optionally you may also want to run the model during model build to see results in UI.
To open UI from Visual Studio Code on Linux please configure "Start UI" task for the model.
It can be done by using menu Terminal -> Configure Tasks... and create tasks similar to RiskPaths model below:
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
"label": "build-RiskPaths",
"type": "shell",
"command": "make all publish run",
"options": {
"cwd": "models/RiskPaths"
},
"problemMatcher": "$gcc",
"group": {
"kind": "build",
"isDefault": true
},
"dependsOrder": "sequence",
"dependsOn": [
"build-libopenm",
"stop-ui-RiskPaths"
]
},
{
"label": "start-ui-RiskPaths",
"type": "shell",
"command": "../start-ompp-ui-linux.sh",
"options": {
"cwd": "models/RiskPaths"
},
"problemMatcher": []
},
{
"label": "stop-ui-RiskPaths",
"type": "shell",
"command": "../stop-ompp-ui-linux.sh",
"options": {
"cwd": "models/RiskPaths"
},
"problemMatcher": []
},
{
"label": "clean-RiskPaths",
"type": "shell",
"command": "make cleanall",
"options": {
"cwd": "models/RiskPaths"
},
"group": "build",
"problemMatcher": []
},
{
"label": "build-libopenm",
"type": "shell",
"command": "make libopenm",
"options": {
"cwd": "openm"
},
"problemMatcher": "$gcc",
"group": "build"
}
]
}
To start UI please go to menu Terminal -> Run Task... -> start-ui-RiskPaths
After you done with UI it is recommended to shutdown background oms web-service by using Terminal -> Run Task... -> stop-ui-RiskPaths
To start model UI after build completed please change Model.xcconfig variable START_OMPP_UI to "1" or "true" or "yes" (case-sensitive)
