setupEM 0.1.1__tar.gz

setupem-0.1.1/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: setupEM
+Version: 0.1.1
+Summary: Python tool for configuration of gds2palace workflow with GUI.
+Author-email: Volker Muehlhaus <volker@muehlhaus.com>
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: gds2palace>=0.1.2
+Requires-Dist: PySide6
+
+# Create EM Simulation model from GDSII layout files
+
+setupEM provides a graphical user interface (Qt based) to configured gds2palace workflow.
+gds2palace enables an RFIC FEM simulation workflow based on the Palace FEM solver by AWS.
+
+# Installation
+To install the setupEM, activate the venv where you want to install.
+
+Documentation for the gds2palace workflow assumes that you have created a Python venv 
+named "palace" in ~/venv/palace and installed the modules there.
+
+If you follow this, you would first activate the venv: 
+```
+    source ~\venv\palace\bin\activate
+```
+and then install setupEM and dependencies via PyPI: 
+```
+    pip install setupEM    
+```
+
+To upgrade to the latest version, do 
+```
+    pip install setupEM --upgrade   
+```
+
+
+## Missing libraries on installation
+If you see this error message when trying to run setupEM:
+
+```
+qt.qpa.plugin: From 6.5.0, xcb-cursor0 or libxcb-cursor0 is needed to load the Qt xcb platform plugin. qt.qpa.plugin: Could not load the Qt platform plugin "xcb" in "" even though it was found.
+```
+
+you need to install additional Qt libraries:
+
+```
+sudo apt update
+sudo apt install libxcb-cursor0 libxcb-xinerama0 libxcb-xkb1 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-render0 libxcb-shape0 libxcb-shm0 libxcb-sync1 libxcb-xfixes0 libxcb-xinput0 libxcb-xv0 libxcb-util1 libxkbcommon-x11-0
+```
+
+
+# Dependencies
+This module also installs these dependencies:
+    gds2palace
+    PySide6
+    
+

setupem-0.1.1/README.md

@@ -0,0 +1,47 @@
+# Create EM Simulation model from GDSII layout files
+
+setupEM provides a graphical user interface (Qt based) to configured gds2palace workflow.
+gds2palace enables an RFIC FEM simulation workflow based on the Palace FEM solver by AWS.
+
+# Installation
+To install the setupEM, activate the venv where you want to install.
+
+Documentation for the gds2palace workflow assumes that you have created a Python venv 
+named "palace" in ~/venv/palace and installed the modules there.
+
+If you follow this, you would first activate the venv: 
+```
+    source ~\venv\palace\bin\activate
+```
+and then install setupEM and dependencies via PyPI: 
+```
+    pip install setupEM    
+```
+
+To upgrade to the latest version, do 
+```
+    pip install setupEM --upgrade   
+```
+
+
+## Missing libraries on installation
+If you see this error message when trying to run setupEM:
+
+```
+qt.qpa.plugin: From 6.5.0, xcb-cursor0 or libxcb-cursor0 is needed to load the Qt xcb platform plugin. qt.qpa.plugin: Could not load the Qt platform plugin "xcb" in "" even though it was found.
+```
+
+you need to install additional Qt libraries:
+
+```
+sudo apt update
+sudo apt install libxcb-cursor0 libxcb-xinerama0 libxcb-xkb1 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-render0 libxcb-shape0 libxcb-shm0 libxcb-sync1 libxcb-xfixes0 libxcb-xinput0 libxcb-xv0 libxcb-util1 libxkbcommon-x11-0
+```
+
+
+# Dependencies
+This module also installs these dependencies:
+    gds2palace
+    PySide6
+    
+

setupem-0.1.1/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "setupEM"
+version = "0.1.1"
+description = "Python tool for configuration of gds2palace workflow with GUI."
+readme = "README.md"
+authors = [
+    { name = "Volker Muehlhaus", email = "volker@muehlhaus.com" }
+]
+dependencies = [
+    "gds2palace>=0.1.2",
+    "PySide6"
+]
+requires-python = ">=3.9"
+
+[project.scripts]
+setupEM = "setupEM.setupEM:main"
+
+[tool.setuptools.package-data] 
+"setupEM" = ["../examples/*"]
+

setupem-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

setupem-0.1.1/src/examples/pcb_lowpass/palace_pcb_lowpass.py

@@ -0,0 +1,120 @@
+# MODEL FOR GMSH WITH PALACE
+
+import os
+import sys
+import subprocess
+
+# we expect gds2palace in the same directory as this model file
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), 'gds2palace')))
+from gds2palace import *
+
+# Model comments
+# 
+# PCB low pass example, everything is in unit micron (GDS and XML stackup)
+# Port  excitation only, so that we get S11 and S21. Reverse path data is padded with zeros.
+
+
+# ======================== workflow settings ================================
+
+#start solver after creating the model?
+start_simulation = False
+run_command = ['./run_sim']     
+
+# ===================== input files and path settings =======================
+
+gds_filename = "pcb_lowpass.gds"   # geometries
+XML_filename = "pcb_ro4003.xml"          # stackup
+
+# preprocess GDSII for safe handling of cutouts/holes?
+preprocess_gds = True
+
+# merge via polygons with distance less than .. microns, set to 0 to disable via merging.
+merge_polygon_size = 0
+
+# get path for this simulation file
+script_path = utilities.get_script_path(__file__)
+
+# use script filename as model basename
+model_basename = utilities.get_basename(__file__)
+
+# set and create directory for simulation output
+sim_path = utilities.create_sim_path (script_path,model_basename)
+print('Simulation data directory: ', sim_path)
+
+# change path to models script path
+modelDir = os.path.dirname(os.path.abspath(__file__))
+os.chdir(modelDir)
+
+# ======================== simulation settings ================================
+
+settings = {}
+
+settings['unit']   = 1e-6  # geometry is in MILLIMETER for PCB example
+settings['margin'] = 2000    # distance in microns from GDSII geometry boundary to simulation boundary 
+settings['air_around'] = [1000,1000,1000,1000,2000, 10000] # airbox size to simulation boundary
+
+
+settings['fstart']  = 0.1e9
+settings['fstop']   = 6.0e9
+settings['fstep']   = 0.05e9
+
+settings['refined_cellsize'] = 200  # mesh cell size in conductor region
+settings['cells_per_wavelength'] = 10   # how many mesh cells per wavelength, must be 10 or more
+
+settings['meshsize_max'] = 5000  # in project units, override cells_per_wavelength 
+settings['adaptive_mesh_iterations'] = 0
+settings['z_thickness_factor'] = 1  
+
+# settings['nogui'] = True  # create files without showing 3D model
+# settings['nogui'] = ('nogui' in sys.argv)  # check if nogui specified on command line, then create files without showing 3D model
+
+
+# Ports from GDSII Data, polygon geometry from specified special layer
+# Excitations can be switched off by voltage=0, those S-parameter will be incomplete then
+
+simulation_ports = simulation_setup.all_simulation_ports()
+# instead of in-plane port specified with target_layername, we here use via port specified with from_layername and to_layername
+simulation_ports.add_port(simulation_setup.simulation_port(portnumber=1, voltage=1, port_Z0=50, source_layernum=201, from_layername='Bottom', to_layername='Top', direction='z'))
+simulation_ports.add_port(simulation_setup.simulation_port(portnumber=2, voltage=0, port_Z0=50, source_layernum=202, from_layername='Bottom', to_layername='Top', direction='z'))
+
+
+# ======================== simulation ================================
+
+# get technology stackup data
+materials_list, dielectrics_list, metals_list = stackup_reader.read_substrate (XML_filename)
+# get list of layers from technology
+layernumbers = metals_list.getlayernumbers()
+layernumbers.extend(simulation_ports.portlayers)
+
+# read geometries from GDSII, only purpose 0
+allpolygons = gds_reader.read_gds(gds_filename, layernumbers, purposelist=[0], metals_list=metals_list, preprocess=preprocess_gds, merge_polygon_size=merge_polygon_size)
+
+
+########### create model ###########
+
+settings['simulation_ports'] = simulation_ports
+settings['materials_list'] = materials_list
+settings['dielectrics_list'] = dielectrics_list
+settings['metals_list'] = metals_list
+settings['layernumbers'] = layernumbers
+settings['allpolygons'] = allpolygons
+settings['sim_path'] = sim_path
+settings['model_basename'] = model_basename
+
+
+# list of ports that are excited (set voltage to zero in port excitation to skip an excitation!)
+excite_ports = simulation_ports.all_active_excitations()
+config_name, data_dir = simulation_setup.create_palace (excite_ports, settings)
+
+
+# for convenience, write run script to model directory
+utilities.create_run_script(sim_path)
+
+
+if start_simulation:
+    try:
+        os.chdir(sim_path)
+        subprocess.run(run_command, shell=True)
+    except:
+        print(f"Unable to run Palace using command ",run_command)
+

setupem-0.1.1/src/examples/sg13_balun_140-170/palace_balun_mesh2.py

@@ -0,0 +1,120 @@
+# MODEL FOR GMSH WITH PALACE
+
+import os
+import sys
+import subprocess
+
+# we expect gds2palace in the same directory as this model file
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), 'gds2palace')))
+from gds2palace import *
+
+
+# Model comments
+# 
+# Balun from D-Band phase shifter design by Rupok Das, Neural Semi, in Tapeout July 2025
+# Design frequency 140-170 GHz
+# https://github.com/IHP-GmbH/TO_July2025/tree/main/FMD_QNC_D_Band_Phase_Shifter
+# Ports: Model uses a via port that is defined between Metal3 and TopMetal2 
+
+
+# ======================== workflow settings ================================
+
+# preview model/mesh only, without running solver?
+start_simulation = False
+run_command = ['start', 'wsl.exe']   
+
+# ===================== input files and path settings =======================
+
+gds_filename = "Balun_140-170G_RupokDas_with_ports.gds"   # geometries
+XML_filename = "SG13G2_nosub.xml"          # stackup
+
+# preprocess GDSII for safe handling of cutouts/holes?
+preprocess_gds = False
+
+# merge via polygons with distance less than .. microns, set to 0 to disable via merging.
+merge_polygon_size = 2.0
+
+# get path for this simulation file
+script_path = utilities.get_script_path(__file__)
+
+# use script filename as model basename
+model_basename = utilities.get_basename(__file__)
+
+# set and create directory for simulation output
+sim_path = utilities.create_sim_path (script_path,model_basename)
+print('Simulation data directory: ', sim_path)
+
+# change path to models script path
+modelDir = os.path.dirname(os.path.abspath(__file__))
+os.chdir(modelDir)
+
+# ======================== simulation settings ================================
+
+settings = {}
+
+settings['unit']   = 1e-6  # geometry is in microns
+settings['margin'] = 50    # distance in microns from GDSII geometry boundary to simulation boundary 
+
+settings['fstart']  = 100e9
+settings['fstop']   = 200e9
+settings['fstep']   = 1e9
+
+settings['refined_cellsize'] = 2  # mesh cell size in conductor region
+settings['cells_per_wavelength'] = 10   # how many mesh cells per wavelength, must be 10 or more
+
+settings['meshsize_max'] = 70  # microns, override cells_per_wavelength 
+settings['adaptive_mesh_iterations'] = 0
+settings['z_thickness_factor'] = 0.33  
+
+
+# ports from GDSII Data, polygon geometry from specified special layer
+# note that for multiport simulation, excitations are switched on/off in simulation_setup.createSimulation below
+
+simulation_ports = simulation_setup.all_simulation_ports()
+# instead of in-plane port specified with target_layername, we here use via port specified with from_layername and to_layername
+simulation_ports.add_port(simulation_setup.simulation_port(portnumber=1, voltage=1, port_Z0=50, source_layernum=201, from_layername='Metal3', to_layername='TopMetal2', direction='z'))
+simulation_ports.add_port(simulation_setup.simulation_port(portnumber=2, voltage=1, port_Z0=50, source_layernum=202, from_layername='Metal3', to_layername='TopMetal2', direction='z'))
+simulation_ports.add_port(simulation_setup.simulation_port(portnumber=3, voltage=1, port_Z0=50, source_layernum=203, from_layername='Metal3', to_layername='TopMetal2', direction='z'))
+
+
+# ======================== simulation ================================
+
+# get technology stackup data
+materials_list, dielectrics_list, metals_list = stackup_reader.read_substrate (XML_filename)
+# get list of layers from technology
+layernumbers = metals_list.getlayernumbers()
+layernumbers.extend(simulation_ports.portlayers)
+
+# read geometries from GDSII, only purpose 0
+allpolygons = gds_reader.read_gds(gds_filename, layernumbers, purposelist=[0], metals_list=metals_list, preprocess=preprocess_gds, merge_polygon_size=merge_polygon_size)
+
+
+########### create model ###########
+
+settings['simulation_ports'] = simulation_ports
+settings['materials_list'] = materials_list
+settings['dielectrics_list'] = dielectrics_list
+settings['metals_list'] = metals_list
+settings['layernumbers'] = layernumbers
+settings['allpolygons'] = allpolygons
+settings['sim_path'] = sim_path
+settings['model_basename'] = model_basename
+
+
+# list of ports that are excited (set voltage to zero in port excitation to skip an excitation!)
+excite_ports = simulation_ports.all_active_excitations()
+config_name, data_dir = simulation_setup.create_palace (excite_ports, settings)
+
+
+# for convenience, write run script to model directory
+utilities.create_run_script(sim_path)
+
+
+if start_simulation:
+    try:
+        os.chdir(sim_path)
+        subprocess.run(run_command, shell=True)
+    except:
+        print(f"Unable to run Palace using command ",run_command)
+
+

setupem-0.1.1/src/examples/sg13_microstrip_fast/palace_demo_line.py

@@ -0,0 +1,117 @@
+# MODEL FOR GMSH WITH PALACE
+
+import os
+import sys
+import subprocess
+
+# we expect gds2palace in the same directory as this model file
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), 'gds2palace')))
+from gds2palace import *
+
+# Model comments
+# 
+# Ports: Model uses a via port that is defined between Metal1 and TopMetal2 (not using in-plane port here)
+
+
+# ======================== workflow settings ================================
+
+#start solver after creating the model?
+start_simulation = False
+run_command = ['./run_sim']     
+
+# ===================== input files and path settings =======================
+
+gds_filename = "line_short_viaport.gds"   # geometries
+XML_filename = "SG13G2_nosub.xml"          # stackup
+
+# preprocess GDSII for safe handling of cutouts/holes?
+preprocess_gds = False
+
+# merge via polygons with distance less than .. microns, set to 0 to disable via merging.
+merge_polygon_size = 0
+
+# get path for this simulation file
+script_path = utilities.get_script_path(__file__)
+
+# use script filename as model basename
+model_basename = utilities.get_basename(__file__)
+
+# set and create directory for simulation output
+sim_path = utilities.create_sim_path (script_path,model_basename)
+print('Simulation data directory: ', sim_path)
+
+# change path to models script path
+modelDir = os.path.dirname(os.path.abspath(__file__))
+os.chdir(modelDir)
+
+# ======================== simulation settings ================================
+
+settings = {}
+
+settings['unit']   = 1e-6  # geometry is in microns
+settings['margin'] = 50    # distance in microns from GDSII geometry boundary to simulation boundary 
+
+settings['fstart']  = 0e9
+settings['fstop']   = 50e9
+settings['fstep']   = 2.5e9
+
+settings['refined_cellsize'] = 5  # mesh cell size in conductor region
+settings['cells_per_wavelength'] = 10   # how many mesh cells per wavelength, must be 10 or more
+
+settings['meshsize_max'] = 70  # microns, override cells_per_wavelength 
+settings['adaptive_mesh_iterations'] = 0
+settings['z_thickness_factor'] = 0.33  
+
+# settings['nogui'] = True  # create files without showing 3D model
+# settings['nogui'] = ('nogui' in sys.argv)  # check if nogui specified on command line, then create files without showing 3D model
+
+
+# Ports from GDSII Data, polygon geometry from specified special layer
+# Excitations can be switched off by voltage=0, those S-parameter will be incomplete then
+
+simulation_ports = simulation_setup.all_simulation_ports()
+# instead of in-plane port specified with target_layername, we here use via port specified with from_layername and to_layername
+simulation_ports.add_port(simulation_setup.simulation_port(portnumber=1, voltage=1, port_Z0=50, source_layernum=201, from_layername='Metal1', to_layername='TopMetal2', direction='z'))
+simulation_ports.add_port(simulation_setup.simulation_port(portnumber=2, voltage=0, port_Z0=50, source_layernum=202, from_layername='Metal1', to_layername='TopMetal2', direction='z'))
+
+
+# ======================== simulation ================================
+
+# get technology stackup data
+materials_list, dielectrics_list, metals_list = stackup_reader.read_substrate (XML_filename)
+# get list of layers from technology
+layernumbers = metals_list.getlayernumbers()
+layernumbers.extend(simulation_ports.portlayers)
+
+# read geometries from GDSII, only purpose 0
+allpolygons = gds_reader.read_gds(gds_filename, layernumbers, purposelist=[0], metals_list=metals_list, preprocess=preprocess_gds, merge_polygon_size=merge_polygon_size)
+
+
+########### create model ###########
+
+settings['simulation_ports'] = simulation_ports
+settings['materials_list'] = materials_list
+settings['dielectrics_list'] = dielectrics_list
+settings['metals_list'] = metals_list
+settings['layernumbers'] = layernumbers
+settings['allpolygons'] = allpolygons
+settings['sim_path'] = sim_path
+settings['model_basename'] = model_basename
+
+
+# list of ports that are excited (set voltage to zero in port excitation to skip an excitation!)
+excite_ports = simulation_ports.all_active_excitations()
+config_name, data_dir = simulation_setup.create_palace (excite_ports, settings)
+
+
+# for convenience, write run script to model directory
+utilities.create_run_script(sim_path)
+
+
+if start_simulation:
+    try:
+        os.chdir(sim_path)
+        subprocess.run(run_command, shell=True)
+    except:
+        print(f"Unable to run Palace using command ",run_command)
+

setupem-0.1.1/src/examples/sg13_rfcmim/palace_rfcmim.py

@@ -0,0 +1,114 @@
+# MODEL FOR GMSH WITH PALACE
+
+import os
+import sys
+import subprocess
+
+# we expect gds2palace in the same directory as this model file
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), 'gds2palace')))
+from gds2palace import *
+
+# Model comments
+# 
+# Ports: Model uses a via port that is defined between Metal1 and TopMetal2 (not using in-plane port here)
+
+
+# ======================== workflow settings ================================
+
+#start solver after creating the model?
+start_simulation = False
+run_command = ['./run_sim']   
+
+# ===================== input files and path settings =======================
+
+gds_filename = "rfcmim_30x15x10_full.gds"   # geometries
+XML_filename = "SG13G2_200um.xml"          # stackup
+
+# preprocess GDSII for safe handling of cutouts/holes?
+preprocess_gds = True
+
+# merge via polygons with distance less than .. microns, set to 0 to disable via merging.
+merge_polygon_size = 2
+
+# get path for this simulation file
+script_path = utilities.get_script_path(__file__)
+
+# use script filename as model basename
+model_basename = utilities.get_basename(__file__)
+
+# set and create directory for simulation output
+sim_path = utilities.create_sim_path (script_path,model_basename)
+print('Simulation data directory: ', sim_path)
+
+# change path to models script path
+modelDir = os.path.dirname(os.path.abspath(__file__))
+os.chdir(modelDir)
+
+# ======================== simulation settings ================================
+
+settings = {}
+
+settings['unit']   = 1e-6  # geometry is in microns
+settings['margin'] = 50    # distance in microns from GDSII geometry boundary to simulation boundary 
+
+settings['fstart']  = 0e9
+settings['fstop']   = 100e9
+settings['fstep']   = 1e9
+
+settings['refined_cellsize'] = 2  # mesh cell size in conductor region
+settings['cells_per_wavelength'] = 10   # how many mesh cells per wavelength, must be 10 or more
+
+settings['meshsize_max'] = 70  # microns, override cells_per_wavelength 
+settings['adaptive_mesh_iterations'] = 0
+settings['z_thickness_factor'] = 0.33  
+
+
+# Ports from GDSII Data, polygon geometry from specified special layer
+# Excitations can be switched off by voltage=0, those S-parameter will be incomplete then
+
+simulation_ports = simulation_setup.all_simulation_ports()
+# instead of in-plane port specified with target_layername, we here use via port specified with from_layername and to_layername
+simulation_ports.add_port(simulation_setup.simulation_port(portnumber=1, voltage=1, port_Z0=50, source_layernum=201, from_layername='Metal1', to_layername='TopMetal1', direction='z'))
+simulation_ports.add_port(simulation_setup.simulation_port(portnumber=2, voltage=1, port_Z0=50, source_layernum=202, from_layername='Metal1', to_layername='Metal5', direction='z'))
+
+
+# ======================== simulation ================================
+
+# get technology stackup data
+materials_list, dielectrics_list, metals_list = stackup_reader.read_substrate (XML_filename)
+# get list of layers from technology
+layernumbers = metals_list.getlayernumbers()
+layernumbers.extend(simulation_ports.portlayers)
+
+# read geometries from GDSII, only purpose 0
+allpolygons = gds_reader.read_gds(gds_filename, layernumbers, purposelist=[0], metals_list=metals_list, preprocess=preprocess_gds, merge_polygon_size=merge_polygon_size)
+
+
+########### create model ###########
+
+settings['simulation_ports'] = simulation_ports
+settings['materials_list'] = materials_list
+settings['dielectrics_list'] = dielectrics_list
+settings['metals_list'] = metals_list
+settings['layernumbers'] = layernumbers
+settings['allpolygons'] = allpolygons
+settings['sim_path'] = sim_path
+settings['model_basename'] = model_basename
+
+
+# list of ports that are excited (set voltage to zero in port excitation to skip an excitation!)
+excite_ports = simulation_ports.all_active_excitations()
+config_name, data_dir = simulation_setup.create_palace (excite_ports, settings)
+
+
+# for convenience, write run script to model directory
+utilities.create_run_script(sim_path)
+
+
+if start_simulation:
+    try:
+        os.chdir(sim_path)
+        subprocess.run(run_command, shell=True)
+    except:
+        print(f"Unable to run Palace using command ",run_command)
+

setupem-0.1.1/src/setupEM/__init__.py

@@ -0,0 +1,9 @@
+"""
+setupEM package
+A Python tool for EM setup using gds2palace.
+"""
+
+from .setupEM import main
+
+__all__ = ["main"]
+__version__ = "0.1.0"