Dynamic Simulation Environment - Simulation Development Platform

Introduction

Simulation Development Platform for the Dynamic Simulation Environment (DSE) Core Platform.

Project Structure

L- .devcontainer  Devcontainer used by Codespaces.
  L- Dockerfile   Dockerfile used by Codespaces.
L- dsl            DSL parser (usingChevrotain).
L- lsp            VS Code Language Server.
L- licenses       Third Party Licenses.

Usage

Running ModelC Example Simulations

Start a Codespace, then type the following commands in the terminal window.

# Setup the examples (will download ModelC examples),
$ make examples
$ ls out/examples/modelc/
benchmark/  binary/  extended/  gateway/  gdb/  minimal/  ncodec/  runtime/  simer/  transform/

# Run a simulation using Simer.
$ dse-simer out/examples/minimal

Hint: Find more information about the Simer command options here.

Build

Developer Notes

Dev Containers Extension for VS Code and WSL

Note: Dev Containers is not supported by VS Codium (workarounds may still exist).

Install VS Code Extensions

1. Install the Dev Containers extension (Ctrl-Shift-X, then search "Dev Containers").

2. Install the WSL extension (Ctrl-Shift-X, then search "WSL").

3. From the Remote Explorer, select a WSL Target and then click Connect in New Window. A new VS Code editor will open.

4. Press F1 to bring up the Command Palette and type Dev Containers reopen. You may be prompted to install docker into WSL. Even if already installed, proceed to install Docker again (in your WSL)

WSL indicator shows in the bottom left corner of the VS Code window. The Remote Explorer, added by the WSL extension, will show available WSL Targets.

Start VS Code with a WSL Target (and DevContainer)

Using WSL Bash Terminal:

# Open a new VS Code editor connected to this repo.
cd ~/git/workspace/dse.sdp
code.

# In VS Code, press `F1` and type `Dev Containers reopen`.

# Open a bash terminal to access the DevContainer (i.e. local Codespace).
codespace ➜ /workspaces/dse.sdp (main) $ which task
/usr/local/bin/task
codespace ➜ /workspaces/dse.sdp (main) $

Using VS Code:

1. Click (bottom left) Open a Remote Window, then command Connect to WSL.

2. From the Remote Explorer, select a WSL Target and then click Connect in Current Window.
   A new VS Code editor will open.

3. Select Open Folder and naviage to your dse.sdp repo. Previouly opened repos will be listed in the Remote Explorer.

After that, the container will build ... and eventually you will have the Codespace avaiable in your Terminal Window.

Additional Resources

• Chevrotain Parser
• Dev Containers for VS Code
• Simer (and source code)

Contribute

Please refer to the CONTRIBUTING.md file.

License

Dynamic Simulation Environment FMI Library is open-sourced under the Apache-2.0 license. See the LICENSE and NOTICE files for details.

Third Party Licenses

Third Party Licenses