Adds Simul8 Agent (#26)

Adds dedicated agent for Simul8 software. This agent supports
only batch mode simulation and works only on Windows.
The code also contains one example.

---------
Co-authored-by: Marco Melloni <[email protected]>
Co-authored-by: prasadtalasila <[email protected]>

Author: 3 people

.github/workflows/simul8-agent-ci.yml

@@ -0,0 +1,83 @@
+name: SIMUL8 Agent CI
+
+on:
+  pull_request:
+    paths:
+      - "agents/simul8/**"
+      - ".github/workflows/simul8-agent-ci.yml"
+
+jobs:
+  ci:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [windows-latest]
+
+    # All commands run inside the agent directory
+    defaults:
+      run:
+        working-directory: agents/simul8
+
+    steps:
+      # ───── 1. Checkout ─────
+      - uses: actions/checkout@v4
+
+      # ───── 2. Python + Poetry ─────
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Poetry
+        env:
+          POETRY_HOME: ${{ runner.temp }}/poetry
+        run: |
+          python -m pip install --upgrade pip
+          curl -sSL https://install.python-poetry.org | python -
+
+      - name: Add Poetry to PATH (Windows)
+        if: runner.os == 'Windows'
+        shell: pwsh
+        run: echo "${{ runner.temp }}\poetry\bin" |
+          Out-File -FilePath $env:GITHUB_PATH -Encoding utf8
+
+      # ───── 3. Install dev deps once ─────
+      - name: Install dev dependencies
+        run: poetry install --with dev
+
+      # ───── 4. Format check ─────
+      - name: Check formatting (non-blocking)
+        continue-on-error: true
+        run: poetry run autopep8 --recursive --diff simul8_agent
+
+      # ───── 5. Lint ─────
+      - name: Run pylint (min score 9.0)
+        run: poetry run pylint simul8_agent --fail-under=9
+
+      # ───── 6. Tests ─────
+      - name: Run pytest (with coverage)
+        run: poetry run pytest --cov=simul8_agent --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          files: coverage.xml
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      # ───── 7. Build + dist artefacts ─────
+      - name: Install runtime dependencies
+        run: poetry install --only main
+
+      - name: Build wheel and sdist
+        run: |
+          poetry build --format wheel
+          poetry build --format sdist
+
+      - name: Upload dist artefacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: simul8-agent-dist
+          path: |
+            agents/simul8/dist/*.whl
+            agents/simul8/dist/*.tar.gz
+          retention-days: 1 # minimum allowed (≈24 h)

.gitignore

@@ -195,16 +195,26 @@ agents/matlab/dist/
 **/resources/*.yml
 **/matlab/*.yaml
 **/matlab/*.yml
+**/simul8/*.yml
+**/simul8/*.yaml
 config*.yaml
 simulation*.yaml
 *.csv
+interactive.py
+*_interactive.py
+**/examples/interactive-simulation/*
+# SIMUL8 agent
+agents/simul8/client
+agents/simul8/logs
+*.bk8 
+# Ignore any .s8 files in agents/simul8 (including subdirectories)
+agents/simul8/*.s8
 #SIMULATION BRIDGE 
 /logs
 /certs
 *.pem
 *_use.yaml
 client/
-dist/
 /certs
 *.pem
 *_use.yaml

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
+  "python.testing.pytestArgs": ["."],
   "python.testing.pytestEnabled": true,
-  "python.testing.pytestArgs": ["simulation_bridge/test"],
-  "python.testing.autoTestDiscoverOnSaveEnabled": true,
-  "python.testing.promptToConfigure": false
-}
+  "python.testing.unittestEnabled": false,
+  "python.testing.cwd": "${workspaceFolder}/agents/simul8",
+  "python.testing.autoTestDiscoverOnSaveEnabled": true
+}

agents/simul8/.coveragerc

@@ -0,0 +1,13 @@
+[run]
+omit =
+    */tests/*
+    */venv/*
+    */.venv/*
+    */__init__.py
+    */simul8_agent/docs/*
+    */simul8_agent/resources/*
+
+[report]
+exclude_lines =
+    if __name__ == .__main__.:
+    pragma: no cover

agents/simul8/.markdownlint.json

@@ -0,0 +1,9 @@
+{
+  "default": true,
+  "MD003": { "style": "atx" },
+  "MD007": { "indent": 4 },
+  "no-hard-tabs": false,
+  "whitespace": true,
+  "line-length": true,
+  "MD033": { "allowed_elements": [ "div", "img" , "p", "i"] }
+}

agents/simul8/.pep8

@@ -0,0 +1,2 @@
+[pycodestyle]
+max_line_length = 80