gds2openEMS 0.1.0__tar.gz

gds2openems-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.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.

gds2openems-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+include README.md

gds2openems-0.1.0/PKG-INFO

@@ -0,0 +1,283 @@
+Metadata-Version: 2.4
+Name: gds2openEMS
+Version: 0.1.0
+Summary: Create and run openEMS FDTD model from RFIC GDSII layout file
+Author-email: Volker Muehlhaus <volker@muehlhaus.com>
+License: Apache
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: gdspy>1.6.0
+Requires-Dist: CSXCAD
+Requires-Dist: openEMS
+Dynamic: license-file
+
+# Create openEMS simulation models from GDSII layout files
+
+gds2openEMS provides utility functions for an RFIC FEM simulation workflow based on the openEMS FDTD field solver.
+
+The full repository with examples is available at 
+https://github.com/VolkerMuehlhaus/openems_ihp_sg13g2
+
+
+# Documentation
+Extensive documentation on creating models using gds2openEMS available in PDF format here:
+https://github.com/VolkerMuehlhaus/openems_ihp_sg13g2/tree/main/doc 
+
+# Installation
+To install the gds2openEMS module, activate the venv where you want to install.
+
+Documentation for the gds2openEMS workflow assumes that you have created a Python venv 
+named "openems" in ~/venv/openems and installed the modules there, including the Python modules that come with openEMS itself.
+
+If you follow this, you would first activate the venv: 
+```
+    source ~\venv\openems\bin\activate
+```
+and then install gds2openEMS module and dependencies via PyPI: 
+```
+    pip install gds2openEMS    
+```
+
+To upgrade to the latest version, do 
+```
+    pip install gds2openEMS --upgrade   
+```
+
+
+
+# Dependencies
+This module also installs these dependencies:
+    gdspy > 1.6.0
+
+In addition, you need to install the Python module that ship with openEMS as described there: 
+https://docs.openems.de/python/install.html#python-linux-install 
+
+# Example script using gds2palace
+Below is an example script that create *.json and *msh input files for simulation with Palace.
+Input is a layout in GDSII file format and an XML file with stackup information
+
+```python
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), 'modules')))
+from modules import *
+
+from openEMS import openEMS
+import numpy as np
+
+
+# Model comments
+# 
+# This is a generic model running port excitation for all ports defined below, 
+# to get full [S] matrix data.
+# Output is stored to Touchstone S-parameter file. 
+# No data plots are created by this script.
+
+
+# ======================== workflow settings ================================
+
+# preview model/mesh only?
+# postprocess existing data without re-running simulation?
+preview_only = True
+postprocess_only = False
+
+# ===================== input files and path settings =======================
+
+gds_filename = "line_simple_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 current path to model script path
+os.chdir(os.path.dirname(os.path.abspath(__file__)))
+
+# ======================== simulation settings ================================
+
+unit   = 1e-6  # geometry is in microns
+margin = 50    # distance in microns from GDSII geometry boundary to simulation boundary 
+
+fstart =  0e9
+fstop  = 110e9
+numfreq = 401
+
+refined_cellsize = 1  # mesh cell size in conductor region
+
+# choices for boundary: 
+# 'PEC' : perfect electric conductor (default)
+# 'PMC' : perfect magnetic conductor, useful for symmetries
+# 'MUR' : simple MUR absorbing boundary conditions
+# 'PML_8' : PML absorbing boundary conditions
+Boundaries = ['PEC', 'PEC', 'PEC', 'PEC', 'PEC', 'PEC']
+
+cells_per_wavelength = 20   # how many mesh cells per wavelength, must be 10 or more
+energy_limit = -40          # end criteria for residual energy (dB)
+
+# port configuration, port geometry is read from GDSII file on the specified layer
+simulation_ports = simulation_setup.all_simulation_ports()
+
+# in-plane port is specified with target_layername= and direction x or y
+# via port is specified with from_layername= and to_layername= and direction z
+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=1, 
+                                                           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()
+# we must also read the layers where we added ports, these are not included in technology layers
+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)
+
+# calculate maximum cellsize from wavelength in dielectric
+wavelength_air = 3e8/fstop / unit
+max_cellsize = (wavelength_air)/(np.sqrt(materials_list.eps_max)*cells_per_wavelength) 
+
+# define excitation and stop criteria and boundaries
+FDTD = openEMS(EndCriteria=np.exp(energy_limit/10 * np.log(10)))
+FDTD.SetGaussExcite( (fstart+fstop)/2, (fstop-fstart)/2 )
+FDTD.SetBoundaryCond( Boundaries )
+
+
+########### create model, run and post-process ###########
+
+# run all port excitations, one after another
+
+for port in simulation_ports.ports:
+    simulation_setup.setupSimulation   ([port.portnumber], 
+                                        simulation_ports, 
+                                        FDTD, 
+                                        materials_list, 
+                                        dielectrics_list, 
+                                        metals_list, 
+                                        allpolygons, 
+                                        max_cellsize, 
+                                        refined_cellsize, 
+                                        margin, 
+                                        unit, 
+                                        xy_mesh_function=util_meshlines.create_xy_mesh_from_polygons)
+    
+    simulation_setup.runSimulation  ([port.portnumber], 
+                                        FDTD, 
+                                        sim_path, 
+                                        model_basename, 
+                                        preview_only, 
+                                        postprocess_only)
+
+
+# Initialize an empty matrix for S-parameters
+num_ports = simulation_ports.portcount
+s_params = np.empty((num_ports, num_ports, numfreq), dtype=object)
+
+# Define frequency resolution. Due to FFT from Empire time domain results, 
+# this is postprocessing and we can change it again at any time.
+f = np.linspace(fstart,fstop,numfreq)
+
+# Populate the S-parameter matrix with simulation results
+for i in range(1, num_ports + 1):
+    for j in range(1, num_ports + 1):
+        s_params[i-1, j-1] = utilities.calculate_Sij(i, j, f, sim_path, simulation_ports)
+
+# Write to Touchstone *.snp file
+snp_name = os.path.join(sim_path, model_basename + '.s' + str(num_ports) + 'p')
+utilities.write_snp(s_params, f, snp_name)
+
+print('Created S-parameter output file at ', snp_name)
+
+```
+
+XML file for this example:
+
+```xml
+<Stackup schemaVersion="2.0">
+<Materials>
+<Material Name="Activ" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="357141.0" Color="00ff00"/>
+<Material Name="Metal1" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="21640000.0" Color="39bfff"/>
+<Material Name="Metal2" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="23190000.0" Color="ccccd9"/>
+<Material Name="Metal3" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="23190000.0" Color="d80000"/>
+<Material Name="Metal4" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="23190000.0" Color="93e837"/>
+<Material Name="Metal5" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="23190000.0" Color="dcd146"/>
+<Material Name="TopMetal1" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="27800000.0" Color="ffe6bf"/>
+<Material Name="TopMetal2" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="30300000.0" Color="ff8000"/>
+<Material Name="TopVia2" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="3143000.0" Color="ff8000"/>
+<Material Name="TopVia1" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="2191000.0" Color="ffe6bf"/>
+<Material Name="Via4" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="1660000.0" Color="deac5e"/>
+<Material Name="Via3" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="1660000.0" Color="9ba940"/>
+<Material Name="Via2" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="1660000.0" Color="ff3736"/>
+<Material Name="Via1" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="1660000.0" Color="ccccff"/>
+<Material Name="Cont" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="2390000.0" Color="00ffff"/>
+<Material Name="Passive" Type="Dielectric" Permittivity="6.6" DielectricLossTangent="0.0" Conductivity="0" Color="a0a0f0"/>
+<Material Name="SiO2" Type="Dielectric" Permittivity="4.1" DielectricLossTangent="0.0" Conductivity="0" Color="fffcad"/>
+<Material Name="Substrate" Type="Semiconductor" Permittivity="11.9" DielectricLossTangent="0" Conductivity="2.0" Color="01e0ff"/>
+<Material Name="EPI" Type="Semiconductor" Permittivity="11.9" DielectricLossTangent="0" Conductivity="5.0" Color="294fff"/>
+<Material Name="AIR" Type="Dielectric" Permittivity="1.0" DielectricLossTangent="0.0" Conductivity="0" Color="d0d0d0"/>
+<Material Name="LOWLOSS" Type="Conductor" Permittivity="1" DielectricLossTangent="0" Conductivity="1E10" Color="ff0000"/>
+<Material Name="MIM_equiv" Type="Dielectric" Permittivity="16.87" DielectricLossTangent="0.0" Conductivity="0" Color="ff0000"/>
+<Material Name="SiO2" Type="Dielectric" Permittivity="4.1" DielectricLossTangent="0.0" Conductivity="0" Color="fffcad"/>
+</Materials>
+<ELayers LengthUnit="um">
+<Dielectrics>
+<Dielectric Name="AIR" Material="AIR" Thickness="300.0000"/>
+<Dielectric Name="Passive" Material="Passive" Thickness="0.4000"/>
+<Dielectric Name="SiO2" Material="SiO2" Thickness="15.7303"/>
+<!--  Comment: Material name SiO2 is excluded from meshing, so we must use a different name to add some spacing at the bottom of the simulation box  -->
+<Dielectric Name="Spacing" Material="SiO2" Thickness="2.0"/>
+</Dielectrics>
+<Layers>
+<Substrate Offset="2.0"/>
+<Layer Name="Activ" Type="conductor" Zmin="0.0000" Zmax="0.4000" Material="Activ" Layer="1"/>
+<Layer Name="Metal1" Type="conductor" Zmin="1.0400" Zmax="1.4600" Material="Metal1" Layer="8"/>
+<Layer Name="Metal2" Type="conductor" Zmin="2.0000" Zmax="2.4900" Material="Metal2" Layer="10"/>
+<Layer Name="Metal3" Type="conductor" Zmin="3.0300" Zmax="3.5200" Material="Metal3" Layer="30"/>
+<Layer Name="Metal4" Type="conductor" Zmin="4.0600" Zmax="4.5500" Material="Metal4" Layer="50"/>
+<Layer Name="Metal5" Type="conductor" Zmin="5.0900" Zmax="5.5800" Material="Metal5" Layer="67"/>
+<Layer Name="TopMetal1" Type="conductor" Zmin="6.4303" Zmax="8.4303" Material="TopMetal1" Layer="126"/>
+<Layer Name="TopMetal2" Type="conductor" Zmin="11.2303" Zmax="14.2303" Material="TopMetal2" Layer="134"/>
+<Layer Name="TopVia2" Type="via" Zmin="8.4303" Zmax="11.2303" Material="TopVia2" Layer="133"/>
+<Layer Name="TopVia1" Type="via" Zmin="5.5800" Zmax="6.4303" Material="TopVia1" Layer="125"/>
+<Layer Name="Via4" Type="via" Zmin="4.5500" Zmax="5.0900" Material="Via4" Layer="66"/>
+<Layer Name="Via3" Type="via" Zmin="3.5200" Zmax="4.0600" Material="Via3" Layer="49"/>
+<Layer Name="Via2" Type="via" Zmin="2.4900" Zmax="3.0300" Material="Via2" Layer="29"/>
+<Layer Name="Via1" Type="via" Zmin="1.4600" Zmax="2.0000" Material="Via1" Layer="19"/>
+<Layer Name="Cont" Type="via" Zmin="0.4000" Zmax="1.0400" Material="Cont" Layer="6"/>
+<Layer Name="MIM_DK" Type="conductor" Zmin="5.5800" Zmax="5.6800" Material="MIM_equiv" Layer="36"/>
+<Layer Name="MIM" Type="conductor" Zmin="5.6800" Zmax="6.4303" Material="TopVia1" Layer="36"/>
+</Layers>
+</ELayers>
+</Stackup>
+```