From e9a2ec1aa9c70f75e13e7306d42379e21c980e93 Mon Sep 17 00:00:00 2001
From: Milan Rother <milan.rother@gmx.de>
Date: Wed, 4 Nov 2026 20:39:57 +0100
Subject: [PATCH] Block icons in the template, pypi environment for publishing

---
 .github/workflows/publish.yml               |  1 +
 TEMPLATE.md                                 | 10 +++++++++-
 src/pathsim_toolbox/icons/FirstOrderLag.svg |  1 +
 tests/test_example_block.py                 |  4 ++++
 4 files changed, 15 insertions(+), 1 deletion(-)
 create mode 100644 src/pathsim_toolbox/icons/FirstOrderLag.svg

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index f65f83f..0fdbd05 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -12,6 +12,7 @@ permissions:
 jobs:
   publish:
     runs-on: ubuntu-latest
+    environment: pypi
     steps:
       - uses: actions/checkout@v4
         with:
diff --git a/TEMPLATE.md b/TEMPLATE.md
index 9e4540b..5aa767b 100644
--- a/TEMPLATE.md
+++ b/TEMPLATE.md
@@ -36,6 +36,13 @@ repo, removes the template banner from `README.md`, and finally deletes
 - `src/pathsim_<name>/example_block.py` — replace `FirstOrderLag` with your
   real blocks. Keep the structure: header comment, docstring documenting
   math / parameters / ports, input validation, `*_port_labels`.
+- `src/pathsim_<name>/icons/` — one SVG icon per block class, named
+  `<ClassName>.svg`. `Block.icon()` (pathsim 0.30 and later) reads it from
+  there and PathView shows it on the canvas. Follow the core icons in
+  [`pathsim/icons`](https://github.com/pathsim/pathsim/tree/master/src/pathsim/icons):
+  viewBox `0 0 96 64`, `fill="none" stroke="currentColor" stroke-width="1.6"`,
+  no colors, since the editor sets them. Blocks without a file have no icon,
+  and subclasses don't inherit the icon of their parent.
 - `tests/` — mirror the structure of `src/`. Tests run with both `unittest`
   and `pytest`; physics is verified through a full `Simulation`.
 - `docs/source/examples/` — example notebooks. The placeholder is a copied
@@ -111,4 +118,5 @@ all rendering.
 a GitHub Release is published. Versions come from git tags via `setuptools-scm`,
 so tag releases as `vX.Y.Z`. Configure a
 [PyPI trusted publisher](https://docs.pypi.org/trusted-publishers/) for the
-project pointing at this repo and the `publish.yml` workflow.
+project pointing at this repo, the `publish.yml` workflow and the `pypi`
+environment.
diff --git a/src/pathsim_toolbox/icons/FirstOrderLag.svg b/src/pathsim_toolbox/icons/FirstOrderLag.svg
new file mode 100644
index 0000000..fd088d3
--- /dev/null
+++ b/src/pathsim_toolbox/icons/FirstOrderLag.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 96 64" fill="none" stroke="currentColor" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round"><line x1="10" y1="50" x2="86" y2="50"/><line x1="10" y1="10" x2="10" y2="54"/><path d="M 14 50 L 15.15 50 L 16.31 50 L 17.46 50 L 18.61 50 L 19.76 50 L 20.92 50 L 22.07 50 L 23.22 50 L 24.37 49.5 L 25.53 46.31 L 26.68 43.4 L 27.83 40.76 L 28.98 38.36 L 30.14 36.17 L 31.29 34.17 L 32.44 32.36 L 33.59 30.71 L 34.75 29.21 L 35.9 27.84 L 37.05 26.6 L 38.2 25.47 L 39.36 24.44 L 40.51 23.5 L 41.66 22.64 L 42.81 21.87 L 43.97 21.16 L 45.12 20.52 L 46.27 19.93 L 47.42 19.4 L 48.58 18.91 L 49.73 18.47 L 50.88 18.07 L 52.03 17.7 L 53.19 17.37 L 54.34 17.07 L 55.49 16.79 L 56.64 16.54 L 57.8 16.31 L 58.95 16.11 L 60.1 15.92 L 61.25 15.74 L 62.41 15.59 L 63.56 15.44 L 64.71 15.31 L 65.86 15.2 L 67.02 15.09 L 68.17 14.99 L 69.32 14.9 L 70.47 14.82 L 71.63 14.75 L 72.78 14.68 L 73.93 14.62 L 75.08 14.56 L 76.24 14.51 L 77.39 14.47 L 78.54 14.42 L 79.69 14.39 L 80.85 14.35 L 82 14.32"/></svg>
diff --git a/tests/test_example_block.py b/tests/test_example_block.py
index d425cc4..8c12f52 100644
--- a/tests/test_example_block.py
+++ b/tests/test_example_block.py
@@ -29,6 +29,10 @@ def test_invalid_params(self):
         with self.assertRaises(ValueError):
             FirstOrderLag(tau=-1.0)
 
+    def test_icon(self):
+        # read from src/pathsim_toolbox/icons by Block.icon()
+        self.assertTrue(FirstOrderLag.icon().startswith("<svg"))
+
 
 class TestFirstOrderLagSimulation(unittest.TestCase):
     """Physics tests run via a full PathSim Simulation."""