setupEM 0.14.2__tar.gz → 0.16.0__tar.gz

setupem-0.16.0/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: setupEM
+Version: 0.16.0
+Summary: Python tool for configuration of gds2palace workflow with GUI.
+Author-email: Volker Muehlhaus <volker@muehlhaus.com>
+License-Expression: GPL-3.0-or-later
+Project-URL: Homepage, https://github.com/VolkerMuehlhaus/setupEM
+Project-URL: Repository, https://github.com/VolkerMuehlhaus/setupEM
+Project-URL: Changelog, https://github.com/VolkerMuehlhaus/setupEM/blob/main/doc/CHANGES.md
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: gds2palace>=0.9.3
+Requires-Dist: gds_prepare_for_EM>=1.6.0
+Requires-Dist: PySide6
+Requires-Dist: shiboken6
+Requires-Dist: scipy
+Requires-Dist: requests
+Requires-Dist: scikit-rf
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: gdspy
+Requires-Dist: meshio
+Requires-Dist: pyvista
+Requires-Dist: pyvistaqt
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# Python GUI for gds2palace 
+
+![Intro](https://raw.githubusercontent.com/VolkerMuehlhaus/setupEM/main/doc/png/setupEM_banner.png)
+
+## Install
+
+    pip install setupEM
+
+**Full documentation, installation guide, and usage walkthrough:**
+https://github.com/VolkerMuehlhaus/setupEM
+
+## Recent changes
+
+# What's New - October 31, 2026 (setupEM 0.16.0)
+
+**After a new export from the layout tool** (setupEM): a layout tool such as the KLayout plug-in klayout_em_export writes the GDSII file and a `.simcfg`, and writes both again when the layout changes. The settings you made in setupEM since are only in your model script, because Create Model writes the script, not the `.simcfg`. setupEM now takes from such a `.simcfg` only the ports, GDSII file, stackup, cell and purpose, and keeps everything else as in the script:
+- Opening a `.simcfg` when a model script for the same GDSII file exists next to it asks whether to **Continue with the script** (edit it in place, ports and layout settings from the `.simcfg`) or **Start from the config**.
+- Loading a `.simcfg` while editing a script in place lists the ports and layout settings that differ and asks whether to **Update the script from it** or **Open it as a new model**. Before, loading it ended editing in place and replaced all settings.
+- While editing a script in place, the bar below the menu points out a newer `.simcfg` of the same GDSII file with other ports or layout settings, with **Update from it**.
+
+**Load Config, Import from \*.py model and Edit \*.py model in place** start in the folder of the model you are working on (the config or script loaded last, else the GDSII file). Before, they started in the folder setupEM was launched from, e.g. KLayout's when the KLayout plug-in opened setupEM.
+
+setupEM 0.16.0 needs gds2palace 0.9.3 or later: a layout with several shapes on one port layer (e.g. a transistor terminal on several fingers, from the KLayout plug-in) makes one port with several elements there; older gds2palace versions used only the last shape.
+
+**Fixes:**
+- `scripts/combine_extend_snp.py` is the same as gds2palace's again. It had missed three fixes made there in September: the port impedance lookup for AMR iterations, the missing `.sNp` extension for a model name that contains a dot, and Touchstone output after an interrupted Palace run.
+- On Linux with GNOME (Wayland), the mouse cursor no longer keeps spinning for about 10 seconds after setupEM starts. setupEM briefly opened three invisible windows while building the Input Files tab, and GNOME waited for them to finish starting.
+- Via ports with direction `-Z` keep their from and to layers. Before, loading a `.simcfg` dropped them, and Create Model wrote such a port as an in-plane port.
+- An incomplete port (direction and layers that don't fit, e.g. from a `.simcfg` written by another tool) gives a warning in the Ports tab. Before, gds2palace exited and setupEM closed. A lowercase `z` counts as a via port too.
+- `combine_extend_snp` (Touchstone output after a Palace run) handles ports with several elements (several shapes on one port layer, gds2palace 0.9.3): one Z0 per port in the option line, and the elements' port inductances combined in parallel for de-embedding. Before, the last element overwrote the others.
+
+# What's New - October 29, 2026
+
+**File > Edit \*.py model in place** (new, setupEM and setupThermal): edits a gds2palace model script directly, e.g. one from the gds2palace MCP server, an example or your own code. Create Model and **File > Save** write only the values you change; the script's loops, comments and custom code stay. Settings the script computes itself are greyed out. A script that builds several models (a parameter sweep) lists them on the Create Model tab, and Start Simulation runs the ticked ones. After importing a script that setupEM didn't write, a bar below the menu offers **Edit in place instead**.
+
+**File > Import from \*.py model** now runs a gds2palace script to read it, without reading the GDSII file and without meshing. The run stops where the script builds the model, so its solver start never runs. The import now gets exactly what gds2palace would get, also values and ports the script computes. Before, ports made in a loop (as in many gds2palace MCP scripts) were left out, and the imported model was missing them. The script's own code before building the model does run, e.g. a script that generates its GDSII file writes it. If the run fails, the import reads the script text as before, and the bar below the menu says why.
+
+**File menu:** the three Recent submenus are now one **Open Recent** submenu, with sections for configs, imported \*.py models and \*.py models edited in place. A file reopens the way it was opened. The menu is grouped as open, recent, save, preferences. **Load Default Config** and **Save as Default Config** are removed: defaults for new models are set in **File > Preferences**. An existing `default.simcfg` / `default.tsimcfg` in your home directory still opens with **Load Config**, and **Save Config** can write it.
+
+Import and edit in place now read a stackup given as `utilities.get_stackup_path("SG13G2_FEM_200um.xml")`, the way the gds2palace MCP server writes it (needs gds2palace 0.9.1 or later). Before, an imported model using that syntax had no stackup file.
+
+# What's New - October 21, 2026
+
+**Tools > Simplify GDS:** the simplification code moved to gds_prepare_for_EM (module `gds_simplify_for_em`), where the gds2palace MCP server uses it too. setupEM now requires gds_prepare_for_EM 1.6.0 or later; `pip install --upgrade setupEM` updates it.
+
+Fix: with **Merge via arrays** (and no fill removal or merging per layer), the simplified file still contained the original subcells as extra top-level cells. Without a cell name, gds2palace reads the first top-level cell, which could be one of them, e.g. a pad cell instead of the design. These left-over cells are now removed.
+
+Full history: [CHANGES.md](https://github.com/VolkerMuehlhaus/setupEM/blob/main/doc/CHANGES.md)
+
+---
+
+**Note:** the `setupEM` PyPI package itself requires:
+
+- gds2palace>=0.9.3
+- gds_prepare_for_EM>=1.6.0
+- PySide6
+- shiboken6
+- scipy
+- requests
+- scikit-rf
+- matplotlib
+- numpy
+- gdspy
+- meshio
+- pyvista
+- pyvistaqt
+
+(Other Python modules mentioned above are only needed to run standalone helper scripts in this repository, not to use the installed package.)

{setupem-0.14.2 → setupem-0.16.0}/README.md

@@ -269,9 +269,11 @@ Behind the scenes, the setupEM user interface created Python model code for gds2
 <img src="./doc/png/code1.png" alt="code" width="700">
 
 ## File menu
-In the setupEM File menu, you can save and load simulation configurations, and you can also save and load a user defined "Default Config" configuration. This includes the choice of simulation target directory and all other settings. Configurations are stored in a JSON file with file extension ".simcfg". The "Default Config" will be stored to the user home diretory.
+In the setupEM File menu, you can save and load simulation configurations. This includes the choice of simulation target directory and all other settings. Configurations are stored in a JSON file with file extension ".simcfg". Default values for new models are set in File > Preferences.
 
-Using "File > Import from *.py model", you can load settings from existing simulation model code, e.g. the examples included in the gds2palace repository. This import is based on detecting known keywords, with or without the settings[] syntax, and also works for openEMS Python models. Note that openEMS substrates model the MIM differently, and parameter "refined_cellsize" will usually be smaller in openEMS simulation, so you need to adjust these settings.
+Using "File > Import from *.py model", you can load settings from existing simulation model code, e.g. the examples included in the gds2palace repository. A gds2palace script is run to read it, without reading the GDSII file and without meshing, so also values and ports the script computes are imported. If that fails, and for openEMS Python models, the import detects known keywords in the script text, with or without the settings[] syntax. Note that openEMS substrates model the MIM differently, and parameter "refined_cellsize" will usually be smaller in openEMS simulation, so you need to adjust these settings.
+
+Using "File > Edit *.py model in place", setupEM edits a gds2palace model script directly, e.g. one created by the gds2palace MCP server or written by hand: it writes only the values you change back into the script, its loops, comments and custom code stay.
 
 If you are on the "Code" tab, you can also export the Python model code using "File > Export to *.py model". This option is only required if you want to save the model code **without** running it. Buttons "Create mesh and model file" and "Run Palace" on the "Create Model" tab will also save the model code to the target directory, and run it from there.
 

setupem-0.16.0/README_pypi.md

@@ -0,0 +1,68 @@
+# Python GUI for gds2palace 
+
+![Intro](https://raw.githubusercontent.com/VolkerMuehlhaus/setupEM/main/doc/png/setupEM_banner.png)
+
+## Install
+
+    pip install setupEM
+
+**Full documentation, installation guide, and usage walkthrough:**
+https://github.com/VolkerMuehlhaus/setupEM
+
+## Recent changes
+
+# What's New - October 31, 2026 (setupEM 0.16.0)
+
+**After a new export from the layout tool** (setupEM): a layout tool such as the KLayout plug-in klayout_em_export writes the GDSII file and a `.simcfg`, and writes both again when the layout changes. The settings you made in setupEM since are only in your model script, because Create Model writes the script, not the `.simcfg`. setupEM now takes from such a `.simcfg` only the ports, GDSII file, stackup, cell and purpose, and keeps everything else as in the script:
+- Opening a `.simcfg` when a model script for the same GDSII file exists next to it asks whether to **Continue with the script** (edit it in place, ports and layout settings from the `.simcfg`) or **Start from the config**.
+- Loading a `.simcfg` while editing a script in place lists the ports and layout settings that differ and asks whether to **Update the script from it** or **Open it as a new model**. Before, loading it ended editing in place and replaced all settings.
+- While editing a script in place, the bar below the menu points out a newer `.simcfg` of the same GDSII file with other ports or layout settings, with **Update from it**.
+
+**Load Config, Import from \*.py model and Edit \*.py model in place** start in the folder of the model you are working on (the config or script loaded last, else the GDSII file). Before, they started in the folder setupEM was launched from, e.g. KLayout's when the KLayout plug-in opened setupEM.
+
+setupEM 0.16.0 needs gds2palace 0.9.3 or later: a layout with several shapes on one port layer (e.g. a transistor terminal on several fingers, from the KLayout plug-in) makes one port with several elements there; older gds2palace versions used only the last shape.
+
+**Fixes:**
+- `scripts/combine_extend_snp.py` is the same as gds2palace's again. It had missed three fixes made there in September: the port impedance lookup for AMR iterations, the missing `.sNp` extension for a model name that contains a dot, and Touchstone output after an interrupted Palace run.
+- On Linux with GNOME (Wayland), the mouse cursor no longer keeps spinning for about 10 seconds after setupEM starts. setupEM briefly opened three invisible windows while building the Input Files tab, and GNOME waited for them to finish starting.
+- Via ports with direction `-Z` keep their from and to layers. Before, loading a `.simcfg` dropped them, and Create Model wrote such a port as an in-plane port.
+- An incomplete port (direction and layers that don't fit, e.g. from a `.simcfg` written by another tool) gives a warning in the Ports tab. Before, gds2palace exited and setupEM closed. A lowercase `z` counts as a via port too.
+- `combine_extend_snp` (Touchstone output after a Palace run) handles ports with several elements (several shapes on one port layer, gds2palace 0.9.3): one Z0 per port in the option line, and the elements' port inductances combined in parallel for de-embedding. Before, the last element overwrote the others.
+
+# What's New - October 29, 2026
+
+**File > Edit \*.py model in place** (new, setupEM and setupThermal): edits a gds2palace model script directly, e.g. one from the gds2palace MCP server, an example or your own code. Create Model and **File > Save** write only the values you change; the script's loops, comments and custom code stay. Settings the script computes itself are greyed out. A script that builds several models (a parameter sweep) lists them on the Create Model tab, and Start Simulation runs the ticked ones. After importing a script that setupEM didn't write, a bar below the menu offers **Edit in place instead**.
+
+**File > Import from \*.py model** now runs a gds2palace script to read it, without reading the GDSII file and without meshing. The run stops where the script builds the model, so its solver start never runs. The import now gets exactly what gds2palace would get, also values and ports the script computes. Before, ports made in a loop (as in many gds2palace MCP scripts) were left out, and the imported model was missing them. The script's own code before building the model does run, e.g. a script that generates its GDSII file writes it. If the run fails, the import reads the script text as before, and the bar below the menu says why.
+
+**File menu:** the three Recent submenus are now one **Open Recent** submenu, with sections for configs, imported \*.py models and \*.py models edited in place. A file reopens the way it was opened. The menu is grouped as open, recent, save, preferences. **Load Default Config** and **Save as Default Config** are removed: defaults for new models are set in **File > Preferences**. An existing `default.simcfg` / `default.tsimcfg` in your home directory still opens with **Load Config**, and **Save Config** can write it.
+
+Import and edit in place now read a stackup given as `utilities.get_stackup_path("SG13G2_FEM_200um.xml")`, the way the gds2palace MCP server writes it (needs gds2palace 0.9.1 or later). Before, an imported model using that syntax had no stackup file.
+
+# What's New - October 21, 2026
+
+**Tools > Simplify GDS:** the simplification code moved to gds_prepare_for_EM (module `gds_simplify_for_em`), where the gds2palace MCP server uses it too. setupEM now requires gds_prepare_for_EM 1.6.0 or later; `pip install --upgrade setupEM` updates it.
+
+Fix: with **Merge via arrays** (and no fill removal or merging per layer), the simplified file still contained the original subcells as extra top-level cells. Without a cell name, gds2palace reads the first top-level cell, which could be one of them, e.g. a pad cell instead of the design. These left-over cells are now removed.
+
+Full history: [CHANGES.md](https://github.com/VolkerMuehlhaus/setupEM/blob/main/doc/CHANGES.md)
+
+---
+
+**Note:** the `setupEM` PyPI package itself requires:
+
+- gds2palace>=0.9.3
+- gds_prepare_for_EM>=1.6.0
+- PySide6
+- shiboken6
+- scipy
+- requests
+- scikit-rf
+- matplotlib
+- numpy
+- gdspy
+- meshio
+- pyvista
+- pyvistaqt
+
+(Other Python modules mentioned above are only needed to run standalone helper scripts in this repository, not to use the installed package.)

{setupem-0.14.2 → setupem-0.16.0}/pyproject.toml

@@ -12,7 +12,7 @@ authors = [
     { name = "Volker Muehlhaus", email = "volker@muehlhaus.com" }
 ]
 dependencies = [
-    "gds2palace>=0.9.0",
+    "gds2palace>=0.9.3",
     "gds_prepare_for_EM>=1.6.0",
     "PySide6",
     "shiboken6",
@@ -28,6 +28,9 @@ dependencies = [
 ]
 requires-python = ">=3.9"
 
+[project.optional-dependencies]
+test = ["pytest"]
+
 [project.urls]
 Homepage = "https://github.com/VolkerMuehlhaus/setupEM"
 Repository = "https://github.com/VolkerMuehlhaus/setupEM"

{setupem-0.14.2 → setupem-0.16.0}/src/setupEM/__init__.py

@@ -24,4 +24,4 @@ A Python tool for EM setup using gds2palace.
 from .setupEM import main
 
 __all__ = ["main"]
-__version__ = "0.14.2"
+__version__ = "0.16.0"

setupem-0.16.0/src/setupEM/config_update.py

@@ -0,0 +1,179 @@
+########################################################################
+#
+# Copyright 2025 Volker Muehlhaus and IHP PDK Authors
+#
+# Licensed under the GNU General Public License, Version 3.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.gnu.org/licenses/gpl-3.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+########################################################################
+
+"""Update a script edited in place from a settings file (*.simcfg) of the same layout.
+
+A layout tool such as the KLayout plug-in klayout_em_export writes the GDS file and a *.simcfg next to it. When the
+layout changes, it exports again: same GDS file name, new ports (numbered 1..N without gaps, so they can shift).
+A model script made before, maybe edited by hand, still has the old ports. setupEM's edit-in-place mode can update
+it: the settings that belong to the layout (LAYOUT_KEYS and the ports) come from the *.simcfg, everything else
+(frequencies, mesh, the script's own code) stays.
+
+No Qt in here, so the module can be tested on its own.
+"""
+
+import ast
+import glob
+import json
+import os
+
+__all__ = ["LAYOUT_KEYS", "port_differences", "layout_differences", "newer_configs", "model_scripts"]
+
+# saved_values that belong to the layout export, besides the ports
+LAYOUT_KEYS = ("GdsFile", "SubstrateFile", "cellname", "purpose")
+LAYOUT_LABELS = {"GdsFile": "GDSII file", "SubstrateFile": "stackup", "cellname": "cell", "purpose": "purpose"}
+
+_PORT_KEYS = ("source_layernum", "direction", "from_layername", "to_layername", "target_layername")
+
+
+def _port_signature(port):
+    """(source layer, direction, from, to, target) of a port dict; Z0 and excitation are not part of it."""
+    values = []
+    for key in _PORT_KEYS:
+        value = port.get(key)
+        if key == "source_layernum" and value not in (None, ""):
+            value = int(value)
+        elif key == "direction" and isinstance(value, str):
+            value = value.upper()
+        values.append(value or None)
+    layer, direction, frm, to, target = values
+    if direction and "Z" in direction:
+        target = None
+    else:
+        frm = to = None
+    return layer, direction, frm, to, target
+
+
+def _describe(signature):
+    layer, direction, frm, to, target = signature
+    if direction and "Z" in direction:
+        return f"via {frm} -> {to} ({direction}) on layer {layer}"
+    return f"in-plane {direction} on {target}, layer {layer}"
+
+
+def port_differences(old_ports, new_ports):
+    """Readable differences from old_ports to new_ports (lists of port dicts), [] if they match. Compared per port
+    number: layer, direction, from/to/target layer; not Z0 or excitation."""
+    old = {int(p["portnumber"]): _port_signature(p) for p in old_ports if p.get("portnumber") not in (None, "")}
+    new = {int(p["portnumber"]): _port_signature(p) for p in new_ports if p.get("portnumber") not in (None, "")}
+    out = []
+    for number in sorted(set(old) | set(new)):
+        if number not in new:
+            out.append(f"port {number}: removed")
+        elif number not in old:
+            out.append(f"port {number}: new, {_describe(new[number])}")
+        elif old[number] != new[number]:
+            out.append(f"port {number}: was {_describe(old[number])}, now {_describe(new[number])}")
+    return out
+
+
+def _same_path(a, b, base_dir=""):
+    if not a or not b:
+        return a == b
+    norm = lambda p: os.path.normcase(os.path.abspath(os.path.join(base_dir, p)))
+    return norm(a) == norm(b)
+
+
+def layout_differences(old_values, new_values, new_base_dir=""):
+    """Readable differences of the LAYOUT_KEYS from old_values to new_values (saved_values dicts); file paths in
+    new_values relative to new_base_dir."""
+    out = []
+    for key in LAYOUT_KEYS:
+        if key not in new_values:
+            continue
+        old, new = old_values.get(key), new_values.get(key)
+        if key in ("GdsFile", "SubstrateFile"):
+            if not _same_path(old, new, new_base_dir):
+                out.append(f"{LAYOUT_LABELS[key]}: {os.path.basename(old or '-')} -> {os.path.basename(new or '-')}")
+        elif key == "purpose":
+            if [int(p) for p in old or []] != [int(p) for p in new or []]:
+                out.append(f"{LAYOUT_LABELS[key]}: {old} -> {new}")
+        elif old != new:
+            out.append(f"{LAYOUT_LABELS[key]}: {old} -> {new}")
+    return out
+
+
+def newer_configs(script_path, gds_path, folders, suffix=".simcfg", application="setupEM"):
+    """[(path, data)] of the settings files in folders that belong to gds_path (their GdsFile is that file) and are
+    newer than script_path, newest first."""
+    try:
+        script_time = os.path.getmtime(script_path)
+    except OSError:
+        return []
+    seen, out = set(), []
+    for folder in folders:
+        if not folder or not os.path.isdir(folder):
+            continue
+        for path in glob.glob(os.path.join(folder, "*" + suffix)):
+            key = os.path.normcase(os.path.abspath(path))
+            if key in seen:
+                continue
+            seen.add(key)
+            try:
+                if os.path.getmtime(path) <= script_time:
+                    continue
+                with open(path, encoding="utf-8") as f:
+                    data = json.load(f)
+            except (OSError, ValueError):
+                continue
+            if not isinstance(data, dict) or data.get("application") != application:
+                continue
+            gds = (data.get("saved_values") or {}).get("GdsFile")
+            if gds and _same_path(gds, gds_path, os.path.dirname(path)):
+                out.append((path, data))
+    out.sort(key=lambda item: os.path.getmtime(item[0]), reverse=True)
+    return out
+
+
+def _reads_gds(script_path, gds_path):
+    """True if one of the script's string literals, taken relative to the script's folder, is gds_path (the script
+    is read with ast, never run)."""
+    try:
+        with open(script_path, encoding="utf-8", errors="replace") as f:
+            text = f.read()
+    except OSError:
+        return False
+    if os.path.basename(gds_path) not in text:          # cheap test before parsing
+        return False
+    try:
+        tree = ast.parse(text)
+    except (SyntaxError, ValueError):
+        return False
+    folder = os.path.dirname(os.path.abspath(script_path))
+    return any(isinstance(n, ast.Constant) and isinstance(n.value, str) and n.value.lower().endswith(".gds")
+               and _same_path(n.value, gds_path, folder) for n in ast.walk(tree))
+
+
+def model_scripts(gds_path, folders):
+    """Model scripts (*.py) in folders that read gds_path, newest first. Their age says nothing against a settings
+    file of the same layout: a layout tool writes that file again on every export, also after the script was made,
+    while the settings made in setupEM since are only in the script (Create Model writes the script, not the
+    settings file)."""
+    seen, out = set(), []
+    for folder in folders:
+        if not folder or not os.path.isdir(folder):
+            continue
+        for path in glob.glob(os.path.join(folder, "*.py")):
+            key = os.path.normcase(os.path.abspath(path))
+            if key in seen:
+                continue
+            seen.add(key)
+            if _reads_gds(path, gds_path):
+                out.append(path)
+    out.sort(key=os.path.getmtime, reverse=True)
+    return out

{setupem-0.14.2 → setupem-0.16.0}/src/setupEM/result_viewer.py

@@ -636,7 +636,12 @@ class ResultViewerWindow(QDialog):
         # regardless of which solver produced it.
         saved_values = self.MainWindow.saved_values
         model_basename = saved_values.get('model_basename', '') if isinstance(saved_values, dict) else ''
-        current_model_dir = f"{model_basename}_data" if model_basename else None
+        current_model_dirs = {f"{model_basename}_data"} if model_basename else set()
+        # a script edited in place may create several models (e.g. a parameter
+        # sweep), each with its own run folder name: all of them are "this model"
+        script_runs = getattr(self.MainWindow, "script_runs", None) or []
+        if getattr(self.MainWindow, "script_model", None) is not None and script_runs:
+            current_model_dirs = {os.path.basename(os.path.normpath(run["sim_path"])) for run in script_runs}
 
         result = []
         for path in files:
@@ -645,8 +650,8 @@ class ResultViewerWindow(QDialog):
                 continue
             if not include_deembedded and '_deembedded' in name:
                 continue
-            if not include_all_models and current_model_dir:
-                if current_model_dir not in os.path.normpath(path).split(os.sep):
+            if not include_all_models and current_model_dirs:
+                if not current_model_dirs & set(os.path.normpath(path).split(os.sep)):
                     continue
             result.append(path)
         return result