OasisLMF/ComplexModelMDK

Run complex models via the MDK

ComplexModelMDK

Run complex model example via MDK

• Install MDK dependent packages, for ubuntu

sudo apt-get update && sudo apt-get install libspatialindex-dev unixodbc-dev build-essential libtool zlib1g-dev autoconf

• Install OasisLMF and other required packages:

  pip install -r requirements.txt
  

• Install the custom item commands and the example custom GulCalc:

  pip install -e .
  

• Run the MDK commands using either implicit calling of the installed package or the explicit specification of a supplier model runner, for example:

  oasislmf model run -C oasislmf_implicit.json --verbose
  
  oasislmf model run -C oasislmf_explicit.json --verbose
  

Run the complex model example using the API & UI

1. install git, docker and docker-compose

For example on an Ubuntu/Debian based Linux system use:

sudo apt update && sudo apt install git docker docker-compose

2. Clone this repository

git clone https://github.com/OasisLMF/ComplexModelMdk.git
cd ComplexModelMdk

3. Run the deployment script

sudo ./install.sh

4. Access via localhost, using the default user: admin pass: password

• OasisUI Interface - localhost:8080/app/BFE_RShiny
• API Swagger UI - localhost:8000
• API Admin Panel - localhost:8000/admin

Notes:

• Gulcalc python class complex_model/OasisLMF_ComplexModelExample_gulcalc.py
• Lookup python class complex_model/DummyComplexModelKeysLookup.py
• Example test data tests/data
• Example model params for the UI model_resource.json