fixed Documentation and path errors

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 2cf15e9dd0634ff4c24aa8a4009c0795
+config: b2fcebc749fbdf0aaf269af8e1ffa997
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_downloads/cc6cf1257ca965545793108a2e49fc9c/MMI_Example.lym

@@ -0,0 +1,217 @@
+<?xml version="1.0" encoding="utf-8"?>
+<klayout-macro>
+ <description/>
+ <version/>
+ <category>pymacros</category>
+ <prolog/>
+ <epilog/>
+ <doc/>
+ <autorun>false</autorun>
+ <autorun-early>false</autorun-early>
+ <shortcut/>
+ <show-in-menu>false</show-in-menu>
+ <group-name/>
+ <menu-path/>
+ <interpreter>python</interpreter>
+ <dsl-interpreter-name/>
+ <text>import pya
+import math
+from kppc.photonics import PhotDevice, PortCreation
+import kppc.photonics.layermaps as lm
+import numpy as np
+import os
+
+class FreePDK45Example(PhotDevice):
+    """Class that provides technology specific data. Currently the backend needs 3 things to be supplied by the technology of the PCells.
+    As these are independent of specific PCells and parameters this should not give any difficulty with the requirement of Klayout to have the Classes stateless.
+
+    The layermap was created from a forum suggestion
+        (`Post &lt;https://community.cadence.com/cadence_technology_forums/f/custom-ic-design/37021/layer-map-file-for-gds-transfer-to-virtuoso&gt;` ) and then some layers were added by hand.
+
+        layermap:       A dictionary containing layers with available purposes, which provide a layer/purpose. This is loaded from a .layermap file.
+                        Example of this FreePDK45:
+                            {'active': {'blockage': (1, 1), 'drawing': (1, 0)}, 'pwell': {'blockage': (2, 1), 'drawing': (2, 0)},...}
+
+        :ivar dataprep_config: Filepath to a text file containing rules for dataprep. This file contains rules for the dataprep.
+                        Copied from the example dataprep.txt:
+                        File Format:
+                        File defining operations for dataprep
+                        Format:
+                        &lt;operation&gt; &lt;source layers&gt; &lt;destination layers&gt; &lt;sizing amount in microns&gt;
+                        Operations supported: add,sub
+                            * add: Create a region from all shapes of the source layers and combine this region with each destion layer region separately
+                            * sub: Same as add but don't build combination but cross-section instead
+                        Sizing amount uses the klayout sizing operation to size the regions of the source layers
+                        During dataprep the regions are merged, meaning overlapping polygons will become one Polygon
+                        source/destination layers are separated by commas if there are multiple
+                        Each argument is separated by white spaces. How many should not matter as they will be parsed by a python str.split() operation which should be able to handle any white space amount.
+                        If the first word of a line is not a supported operation the line will be ignored
+                        The lines will be executed in order meaning and add sub operations on layers will be different than a first sub and then add
+                        :Examples:
+                            active.blockage,poly.blockage,metal1.blockage,metal2.blockage,metal3.blockage,metal4.blockage,metal5.blockage,nwell.drawing,nimplant.drawing 2.0
+
+        :ivar clean_rules:     list containing the layer/purpose numbers and the minWidth/minSpacing rules for the layer/purpose pair in microns
+                        :Examples:
+                            [[(1, 0), 0.097, 0.077],[(2, 0), 0.23, 0.189],[(3, 0), 0.169, 0.196],[(5, 0), 0.044, 0.052], ...]
+        """
+
+    # Define the metals &amp; via names. They will be used in some PCells (Electrodes and ViaStack)
+    metal_names = ['metal' + str(i) for i in range(1, 11)]
+    via_names = ['via' + str(i) for i in range(1, 10)]
+
+    def __init__(self):
+        PhotDevice.__init__(self)
+
+        techpath = pya.Technology.technology_by_name('FreePDK45').base_path()
+
+        filename = techpath + '/FreePDK45.tf'
+
+        # Check if techfile is correctly imported and located
+
+        isfile = os.path.isfile(filename)
+        if not isfile:
+            import sys
+            msg = pya.QMessageBox(pya.Application.instance().main_window())
+            msg.text = 'Please import the techfile of the technology to {} before using the module and reopen KLayout'.format(filename)
+            msg.windowTitle = 'ImportError'
+            msg.exec_()
+
+        tech = con.load_from_tech(filename)
+
+        # Get the layermap file and load it.
+        # CAREFUL: Will be used for dataprep and others
+        self.layermap = lm.load(techpath + '/FreePDK45.layermap')
+
+        # This variable will be imported by the dataprep algorithm
+        # CAREFUL: Will be imported for dataprep
+        self.dataprep_config = techpath + '/dataprep.txt'
+
+        # Rules for the cleaner in the form [[(layer1,purpose1),violation_width1,violation_space1],[(layer2,purpose2),violation_width2,violation_space2],...]
+        ### CAREFUL: This variable will be imported for the cleaning.
+        self.clean_rules = [[(1, 0), 0.111, 0.085], [(2, 0), 0.23, 0.188], [(3, 0), 0.14, 0.199], [(5, 0), 0.044, 0.049],
+                            [(4, 0), 0.046, 0.052], [(9, 0), 0.044, 0.062], [(11, 0), 0.076, 0.077], [(13, 0), 0.073, 0.089],
+                            [(15, 0), 0.067, 0.063], [(17, 0), 0.143, 0.137], [(19, 0), 0.158, 0.14], [(21, 0), 0.145, 0.123],
+                            [(23, 0), 0.514, 0.535], [(25, 0), 0.369, 0.311], [(27, 0), 0.908, 0.843], [(29, 0), 0.347, 0.771],
+                            [(1, 1), 1.247, 1.254], [(2, 1), 0.976, 0.905], [(3, 1), 1.165, 1.304], [(5, 1), 1.073, 0.958],
+                            [(4, 1), 1.058, 0.885], [(9, 1), 0.892, 0.825], [(11, 1), 1.003, 0.682], [(13, 1), 0.983, 0.73],
+                            [(15, 1), 1.086, 0.993], [(17, 1), 1.12, 0.812], [(19, 1), 0.941, 0.765], [(21, 1), 0.942, 0.889],
+                            [(23, 1), 1.044, 0.933], [(25, 1), 1.096, 1.039], [(27, 1), 0.798, 0.937], [(29, 1), 1.001, 1.286]]
+
+class ExMMIBody(FreePDK45Example):
+    """MMI Body. Since this should be a 2x2 MMI it will have 4 ports
+    """
+
+    def __init__(self):
+        FreePDK45Example.__init__(self)
+        self.add_layer('lay',"phot_silicon.drawing")
+        # Important: If it should be a floating point parameter, use x.0 instead of x for default values that fall on integers, or it will be interpreted as integer 
+        params = dict(length=15.,
+                      width=5.,
+                      port_offset=1.5,
+                      port_width =1.0
+                      )
+        # Register the parameters
+        self.add_params(params)
+
+    def create_param_inst(self):
+        # Create Ports here
+        ports = [PortCreation(-self.length/2, self.port_offset, 180, self.port_width),
+                 PortCreation(-self.length/2, -self.port_offset, 180, self.port_width),
+                 PortCreation(self.length/2, -self.port_offset, 0, self.port_width),
+                 PortCreation(self.length/2, self.port_offset, 0, self.port_width)]
+        return ports
+
+    def shapes(self):
+        #Create the Rectangle
+        self.create_polygon([[-self.length/2,-self.width/2],[self.length/2,-self.width/2],[self.length/2,self.width/2],[-self.length/2,self.width/2]],self.lay)
+
+class ExLinTaper(FreePDK45Example):
+
+    def __init__(self):
+        FreePDK45Example.__init__(self)
+        self.add_layer('lay',"phot_silicon.drawing")
+        params = dict(width_0 = .5,
+                      width_1 = 1.0,
+                      length = 2.0,
+                      )
+        self.add_params(params)
+
+    def create_param_inst(self):
+        # Create left and right port
+        port_0 = PortCreation(-self.length/2,0,180,self.width_0)
+        port_1 = PortCreation(self.length/2,0,0,self.width_1)
+        return port_0,port_1
+
+    def shapes(self):
+        # Create taper polygon
+        self.create_polygon([[-self.length/2,-self.width_0/2],
+                             [-self.length/2,self.width_0/2],
+                             [self.length/2,self.width_1/2],
+                             [self.length/2,-self.width_1/2],],
+                            self.lay)
+
+class Ex2x2MMI(FreePDK45Example):
+    """The MMI-cell class.
+    This class instantiates a body with 4 tapers and attaches the tapers to the the body.
+    """
+
+    def __init__(self):
+        FreePDK45Example.__init__(self)
+        self.add_layer('lay','phot_silicon.drawing')
+        params = dict(wg_width=.5,
+                      length=15.0,
+                      taper_width=1.0,
+                      taper_length=2.0,
+                      width=4.0,
+                      taper_offset=1.0,
+                      )
+        self.add_params(params)
+
+    def create_param_inst(self):
+        # Library we load the sub-cells from
+        lib = "FreePDK45_Photonic_FirstExample"
+        bodyname = "MMIBody"
+        tapername = "LinearTaper"
+
+        # Parameters used for the 4-port body
+        body_params = dict(lib = lib,
+                            cellname = bodyname,
+                            width=self.width,
+                            length=self.length,
+                            port_offset=self.taper_offset,
+                            port_width =self.taper_width,
+                            )
+        # Parameters for tapers
+        taper_params = dict(lib = lib,
+                            cellname = tapername,
+                            width_0=self.wg_width,
+                            width_1=self.taper_width,
+                            length=self.taper_length,
+                            )
+        # Create constructors for tapers and body
+        tapers = self.add_pcell_variant(taper_params,number=4)
+        body = self.add_pcell_variant(body_params)
+
+        # Connect the ports
+        for i in range(4):
+            self.connect_port_to_port(body.port(i),tapers[i].port(1))
+
+        # Return constructors
+        return tapers,body
+
+class FreePDK45_ExampleLib(pya.Library):
+    def __init__(self):
+        # Set the description
+        self.description = "FirstExample"
+        self.technology = "FreePDK45"
+        # Create the PCell declarations
+        self.layout().register_pcell("2x2MMI",Ex2x2MMI())
+        self.layout().register_pcell("MMIBody",ExMMIBody())
+        self.layout().register_pcell("LinearTaper",ExLinTaper())
+
+        self.register("FreePDK45_Photonic_FirstExample")
+
+
+# Instantiate and register the library
+FreePDK45_ExampleLib()</text>
+</klayout-macro>

docs/_modules/index.html

@@ -4,7 +4,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>Overview: module code &#8212; KLayout Photonic PCells 0.1.2 documentation</title>
+    <title>Overview: module code &#8212; KLayout Photonic PCells 1.0.2 documentation</title>
     <link rel="stylesheet" href="../_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
 
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">KLayout Photonic PCells 0.1.2 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="../index.html">KLayout Photonic PCells 1.0.2 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -71,7 +71,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">KLayout Photonic PCells 0.1.2 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="../index.html">KLayout Photonic PCells 1.0.2 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">