INTO-CPS Desktop Application¶
Welcome to the INTO-CPS Desktop Application documentation. The best way to get started is to follow the First Steps guide which guides you thorugh the installation process and the basics of the application.
For a guide on how to use the various features of the application User Interface provides an overview of how to access the most important functionality.
Note
The INTO-CPS Toolchain refers to a collection of programs not limited to the the desktop application. For an comprehensive overview of all tools take a look at the INTO-CPS toolchain documentation
First Steps¶
The following sections guides you through the process of installing the application, installing its dependencies and finally demonstrates how a co-simulation can be configured and executed within the application.
Install the application¶
There are two options for installing the application. The recommended approach is to download the latest Release Build, which is may lack bleeding edge features, but is typically much more stable. The alternative, is building the latest Development Build from source, which gives access to the most recently added features, but at a potential cost of stability.
Release Build¶
The latest release of the application for Windows, Linux, and macOS can be found on GitHub Releases. Download and extract the zip archive corresponding to your host architecture. The extracted directory should look similar to this:
Development Build¶
- clone the repository:
git clone https://github.com/INTO-CPS-Association/into-cps-application/tree/development - change working directory to repository:
cd into-cps-application - install node dependencies:
npm install - install other resources:
gulp init - build ui:
gulp - run the test:
npm test
Installing toolchain dependencies¶
The application is modular by design, as such it relies on external programs to support its features. The easiest way to install these is using the built in download manager.
- Start the application by executing the program
into-cps-app-x.x.x - Press the “Window.Show Download Manager” tab, a window will appear
- Select the latest version of the toolchain
- Select and download “Co-simulation Orchestration Engine - Co-simulation”
Note
This guide only installs the dependency necessary to perform co-simulations inside the application. To access other features it may be necessary to install additional programs.
Performing a Co-Simulation¶
Warning
Missing! Here we should explain how to run, say the water tank example.
User Interface¶
The INTO-CPS Application is the front-end of the INTO-CPS tool chain. The following screenshot shows how it looks.
Warning
Here we should explain in simple terms how to use the application. Important concepts such as multimodel-config and co-simulation configuration should be explained!
Additionally, a video demonstation would go a long way
Also we need need to consider what we are trying to convey. For example what information does the old docs convey:
The app is composed of 2 primary views: On the left, the project browser left is always visible. It shows the various components of an INTO-CPS project. These components can be clicked to trigger various actions.
In the center, the main view is shown. The contents of this view depend on which action has been trigerred in the project browser. A few example views are shown below.
Overview¶
The app is composed of 2 primary views: On the left, the project browser left is always visible. It shows the various components of an INTO-CPS project. These components can be clicked to trigger various actions. In the center, the main view is shown. The contents of this view depend on which action has been trigerred in the project browser. A few example views are shown below.
Integrations¶
The application is built in a modular fashion that allows extra functionality to be accessed from within the application by installing extenal tools. Typically, these are installed using the Download Manager, however there are some cases where a plugin must be installed manually.
Below is a overview of the different integrations in terms of the funcationality they provide and how to install them.
