Instructions

In order to upload your simulation models into a Workroom you should first download a special program (called Simantics Desktop), which helps you to transform your codes into the right kind of format so that variables and data can be passed to and from the database of the Modelling Factory. With the aid of the Desktop, you can also build a web app (graphical user interface, GUI) for your model and publish it to the Workroom. In this way both the simulation model itself and its GUI can be shared with other users, who can publish modified versions of both if the license you have granted allows this.

Downloading Simantics Desktop

Simantics Desktop is used for creating simulation models that can be uploaded to Modelling Factory. Simantics Desktop is provided with pre-built binaries for both Windows and Linux operating systems. Some functionality may not behave correctly under Linux operating system so therefore Windows is preferred

OS Platform Download link
Windows x64 Simantics-Desktop-win32.win32.x86_64.zip
Windows x86 Simantics-Desktop-win32.win32.x86.zip
Linux x64 Simantics-Desktop-linux.gtk.x86_64.zip
Licensing

Simantics Platform is licensed under Eclipse Public License. The license does not have to apply to 3rd party applications and plug-ins that are integrated with Simantics. That means, an application built on Simantics can be e.g. a commercial, closed code. Or it can be an open source product. In any case, the application and plug-in licensing have to respect Simantics licensing. E.g. if a plug-in component uses a so-called "Strict GPL", the integration with Simantics has to be done with extra care; the GPL licensed software can't influence the licensing of Simantics platform. For commercial products, the application or plug-in has to be clearly separated from the platform and all the integration code needed in the Simantics platform side has to be licensed under Eclipse Public License (EPL).

More about Simantics Desktop and platform licensing can be found from Simantics Licensing

General work flow

Once your model files have been put into the right format and the necessary GUIs have been constructed, both can be uploaded into a Modelling Factory Workroom. The Workrooms of Modelling Factory can be used for collaboration and dissemination of simulation based results as a web service. You can set up your own own work room by registering and logging into the Modelling Factory. By clicking the Create Workroom button at the top of the Workrooms page opens up a template to fill out. After naming the Workroom and giving a short description of the project, you can upload the necessary program files into the Workroom. These comprise the actual simulation codes of the models you are using. For example, if you project utilizes a Matlab code or C++ code to solve some problem, you should upload the code into the Workroom. It is also possible to perform co-simulation, i.e. make different models exchange information or dynamically trigger events in one another. Also, proprietary and open source models (numerical solvers) can both be used given that they are supported by the Modelling Factory platform.

If you find interesting content in an open Workroom you can download the models and the GUIs by using the same Simantics Desktop tool, which you used for uploading your own models. In other words, use the Simantics Desktop tool to communicate with the Modelling Factory platform whenever you need to prepare your models for uploading or whenever you want to download published models/GUIs from open Workrooms to modify them further.

Manuals

To run the following examples you need the Simantics Desktop tool (see above). We recommend that the simulation models themselves are built using their native programming environments (e.g. IDE for Python, Excel, Octave, etc.) To run the published GUIs of the models, you need no IDE or Simantics Desktop tool as the web apps can be simply run through a browser.

  • Python models

Sample model in Python language

  • R models

How to use R models in Modelling Factory

Sample model in R language

  • Model combinations and Co-simulation

Co-simulation: combining System Dynamic models with Python models

  • Excel models

How to use Excel spreadsheets on Modelling Factory

Sample spreadsheet

  • System Dynamic models

How to install the System Dynamics development environment (a.k.a. workbench)

Full feature system dynamic modeling documentation wiki

  • Coming up next: Octave/Matlab, C++