# Change Log¶

## Ipkiss 3.1¶

There are a few changes in Ipkiss 3.1 that that introduce a backward incompatibility with Ipkiss 3.0.1. These are explained in more detail in Porting from Ipkiss 3.0.1 to Ipkiss 3.1.

### Installation¶

• The installer now works correctly on Windows 10

### Samples & documentation¶

• Small updates to the trainings and samples (samples/ipkiss3/training and samples/ipkiss3/getting_started).
• Improved sample for GDSII import in the documentation.
• Sample on how to find cells in a layout which have a label inside (with a given text). See samples/ipkiss3/samples/advanced/label_layers.
• Guide on technology: this guide explains you how to build your own technology with Ipkiss.
• visualize_2d() does not display the image twice anymore in notebooks.

### Ipcore¶

• Added the decorator @lock_properties() to make all properties of a StrongPropertyInitializer class read-only. See the PCell guide in the documentation for usage.
• Improvement: RestrictTypeList now has a proper string representation (__str__).
• Improvement: RestrictRange can now handle float values, even when the range bounds were specified as integers.

### Ipkiss¶

• New functionality: Added capability to specify Caphe time domain models: pure input/output behavior, Ordinary Differential Equations (ODE) and Coupled Mode Theory (CMT) models can be specified. Note: this is still in an early stage. Simulation models are already defined in IPKISS, but the simulation setup is still done in native Caphe and not in Ipkiss.
• New functionality: Added BoundaryPath element. It is a boundary which keeps a reference to its centre line.
• Fix: Views (Layout, Netlist) are now compared based on overridden properties, but also overridden view data.
• Fix: Net is now available in ipkiss3.all.
• Fix: Automatic transitioning between waveguides is now based on a detailed comparison of the waveguide windows. Note: this may change your design. For example, a PlaceAndAutoRoute component (which uses Connector) may now have less unnecessary transitions.
• Fix: RouteManhattan will no longer yield solutions with bend radii that are too small. However, this could in some cases lead to a waveguide crossing.
• Bugfix: Shapes defined with integer coordinates are now converted to float coordinates to avoid rounding errors.
• Bugfix: ShapeVariableOffset now works properly on simple shapes.
• Bugfix: Boolean operations on Boundary now correctly take a transformation into account.
• Bugfix: Layer filters (LayerFilterAllow, LayerFilterDelete) are fixed. They no longer functioned because the class __LayerElement__ was renamed to _LayerElement.
• Bugfix: Label.size_info() now returns a new empty SizeInfo object (previously, it returned the global EMPTY_SIZE_INFO object).
• Bugfix: The cross section visualization of a layout view now correctly takes the hierarchy into account.
• Bugfix: Trace transitions with zero length now have the correct port angles.
• Bugfix: Rounded waveguides where there is not enough bend space in the first and last section will now throw an error. Previously, this was ignored, which resulted in too small bend radii.
• Bugfix: ElectricalPort is now correctly transformed if you manually set the angle.
• Bugfix: Making a copy of a port also copies the position into a separate coordinate object.
• Bugfix: Small code refactoring to Port, Group, _GroupElement. As a result, a port no longer contains a portlist itself (which is logical).
• Bugfix: The process parameter was not passed in IoColumn.add_blocktitle. The pattern purpose for the text was hardcoded and is now a parameter as well.
• Improvement: NameProperty now prints a valid error message when a non-string is assigned.
• Improvement: Transformable and NoDistortTransformable do no longer take positional arguments (i.e. the __init__ has been removed). This is very unlikely to affect any user code.
• Improvement: Trace transitions originating from a port now have default zero length. This default behavior keeps containers more compact when no transitions are needed.
• Improvement: ShapeProperty is now a class, rather than a shortcut function. This should normally not introduce any compatibility problems, unless you have used the internal_member_name attribute.
• Improvement: The comparison of Trace Templates (and Ipkiss 2.4 Waveguide Definitions) is now more rigorous. As a result, there might be occurences where tapers are removed where trace templates are identical. Also, WgMziGeneric in Picazzo will now add tapers in a more reliable way.
• Improvement: Waveguides and traces now have a default shape: [(0.0, 0.0), (TECH.WG.SHORT_STRAIGHT, 0.0)].
• Improvement: the template property of a templated Waveguide now has a default value. More specifically:
• _TemplatedWaveguide: TECH.PCELLS.WG.DEFAULT.
• TemplatedWindowsOnWaveguide: WindowsOnWaveguideTemplate(trace_template=TECH.PCELLS.WG.DEFAULT).
• [Backward incompatible] Change: environment variable IPKISS_LOG_LEVEL has been renamed to LUCEDA_LOG_LEVEL.

### Picazzo¶

• All Picazzo components now have sensible default values.
• Added waveguide connectors (picazzo3.wg.connector).
• Added inline waveguide gratings (picazzo3.wg.grating).
• Added a logical inline reflector with a Fresnel reflection model (picazzo3.logical.reflector).
• Added StraightGratingLine for simple grating couplers.
• Fix: MziWithCells now calculates the combiner transformation taking into account tapering, and the transformations for splitters and combiners can also be manually overruled.
• Bugfix: MziWithCells now generates a valid MZI arm when the child cell in the arm is specified through inheritance (as a _default_arm1_contents or _default_arm2_contents method)
• Bugfix: angle_step is now correctly passed in the ring resonators (picazzo.filters.ring), from the ring cell to its constituting waveguides.
• Bugfix: get_ring_length() of RingRect.Layout and derived ring resonators now reports the complete ring length instead of one quarter of the ring
• Bugfix: IoFibcoup can now handle west ports routed to east and vice versa, when port labels ("E0", "W1", ...) are used
• Bugfix: Use of predefined columns from genericpdk.library.io.column will now work. There was a syntax error before.
• Bugfix: MMIIdentical now has 3 inputs and 3 outputs by default. There was a circular dependence before.
• Bugfix: RibMMI classes now use the default rib waveguide templates, instead of the default strip waveguides.
• Bugfix: Transition of slot waveguides now adjusts to the layers of the slot waveguide template. Before, these layers were hardcoded.
• Bugfix: Transitions created with AutoTraceTransitionFromPort now have unique names. As a result names of transitions in your design might have changed.
• Bugfix: RoutePortsAroundCorner now has a one-to-one correspondence between the waveguide instances in Netlist and Layout. Before, the waveguide instances were reordered in the layout, which could lead to a mismatch between layotu and netlist.
• Bugfix: Trace chains and Spirals were incorrectly connected on netlist level.
• [Backward incompatible] Improvement: Wire waveguide transitions WireWaveguideTransitionFromPortLinear now have an adaptive length with a minimum of TECH.WG.SHORT_TRANSITION_LENGTH. Note: This will have an effect on your design if you used short tapers between a very wide and a very narrow waveguide. Such short tapers can introduce a large loss, and therefore an adaptive length was introduced: The larger the width mismatch between the two waveguide cores, the longer the taper will be.
• [Backward incompatible] Added property purpose to ElectricalWireTemplate, with default value TECH.PURPOSE.DRAWING. The original purpose that was used was TECH.PURPOSE.DF.LINE. If your technology used TECH.PURPOSE.DF.LINE for drawing electrical wires, you need to change this default.
• Improvements to PlaceAndAutoRoute:
• Added transitions when ports don’t match the trace template.
• Added automatic detection and highlighting of crossing waveguides using the highlight_waveguide_crossings flag.
• Added the method get_waveguide_crossing_points() on the Layout view.
• Added the possibility to manually override individual waveguide routes
• Added min_straight, start_straight, end_straight properties on the Layout view. These influence the behavior of the routing.
• The links property has a proper restriction. It checks if it’s a list, with tuples, and each tuple is exactly size 2.
• Improvement: in FanoutPorts: When no reference coordinate is specified, the first route will follow a more natural shape. Note: this may change behavior of FanoutPorts. It will only occur when you perform a FanoutPorts on a component where the first ports (the reference port) is at an angle with the output direction, and no reference_coordinate is specified. Now the shortest route to the output direction is used, while originally the waveguide could make a somewhat awkward bend. If you manually specify the reference_coordinate, there is no difference.
• Improvement: RoutePortsAroundCorner will now sort the ports before generating the routes.
• Improvement: StraightWgSocket for fiber couplers is now centered around (0,0), rather than starting at (0,0). By default, it now overlays correctly on a straight grating.
• Improvement: MMI and RibMMI classes now have more sensible defaults for widths and input/output positions.
• Improvement: Generic ring resonators (RingShape and RingTraces) now have a default circular shape instead of an empty shape.
• Improvement: ContactHole and Via12 now use "CONTACT" and "VIA12" as name prefix - therefore autogenerated names will change when the name was not manually set.
• Improvement: PlaceandConnect can now logically connect components with electrical as well as optical terms.
• Improvement: The ParabolicCrossing has no hard-coded layer purposes anymore. These can now be set using the properties core_purpose, strip_purpose, cladding_purpose and strip_cladding_purpose.
• Improvement: The generic TraceChain classes now, by default, concatenate 3 right-angle bends. This illustrates the functionality better.
• Improvement: The default width of the intermediate wire of a Rib-to-Wire transition (WireRibWireWaveguideTransitionLinear) is narrower, resulting in a smoother transition.
• Improvements to Spirals:
• The East output section of DoubleSpiralWithIncoupling does not extend as far east as it used to be. It default to TECH.WG.SHORT_STRAIGHT.
• Spiral loops are now cut in 2 to avoid self-intersecting polygons on export.

### Picazzo 2.4¶

• Bugfix: TaperDeepPorts and TaperShallowPorts had wrong port names: multiple ports with the same name could result. The port names of the tapered structure are now identical to the port names of the original structure.
• Removed InWaveguideHeaterDefinition from picazzo.modulators.window_waveguides.

### Ipkiss 2.4¶

• Bugfix: the ipkiss.plugins.electronics.port package could not be imported anymore. This is now fixed (for designers that need to run old 2.4 code that uses electronic ports).

### Pysimul¶

• Small syntax fix in SimulationParameterContainer.

## Ipkiss 3.0.1¶

Changes that introduce a backward incompatibility are explained in more detail in Porting from Ipkiss 3.0 to Ipkiss 3.0.1 .

### Ipcore¶

• Improved error message when a property is not valid.
• BoolProperty and RESTRICT_BOOL now accept int and numpy booleans (numpy.bool_). BoolProperty now stores its value as a python bool.
• Small, but important change in the behavior of number properties:
• Basic type (bool, int, float, complex) properties (such as BoolProperty, IntProperty, NumberProperty and ComplexNumberProperty) always cast the value to the correct type. For example, when 1 is passed to a NumberProperty, it is converted to 1.0.
• [Backward incompatible] FloatProperty now accepts integer values (this means now NumberProperty and FloatProperty are equivalent). The preferred usage is NumberProperty, as it is used in most places. This casting is done to ensure a consistent user experience. It might, in some very specific cases in your code, result in a changed behavior or a warning.
• [Backward incompatible] The set method (or _set_bulk) now only accept keyword arguments that correspond to properties of the component. Originally unknown keywords were ignored, but now unknown keywords will raise an exception. This reduces the chances of obscure bugs due to small programming typos.

### Ipkiss¶

• Trace transitions describe the interface between two different kinds of trace templates (ipkiss3.pcell.trace.transition). This is an improvement on the Tapers in Ipkiss 2.4. Linear and Parabolic transitions are available. Trace transitions are stored in a database (TECH.PCELLS.TRANSITION.AUTO_TRANSITION_DATABASE). Transitions cannot be mixed with ‘tapers’ from Ipkiss 2.4.
• vector_match_transform now has a parameter mirrored to introduce a mirroring operation.
• In a hierarchical PCell with childcells , it was often needed to explicitly evaluate the child views (or perform visualize). This has now been fixed. See the porting guide for more details.
• A wrapper GDSCell to import external GDS files has been added (ipkiss3.pcell.gdscell).
• Adding electrical traces and ports (ipkiss3.pcell.wiring).
• Routes have been ported from Ipkiss 2.4 to Ipkiss 3 (ipkiss3.pcell.routing) * Also available for electrical traces and ports. * Added support for manual routing angles. This can be useful for electrical routing.
• [Future Deprecation] PortList now has dict-like methods keys, values and items. This makes it similar in use as TermDict. Use those methods wherever possible to avoid future deprecation.
• Bugfix: Port.invert() did not return an object.
• Bugfix in OutputGdsii, FileOutputGdsii and write_gdsii: grid and unit arguments were ignored and technology defaults taken. The grid and unit arguments are used now upon GDSII export.
• Bugfix in GDSII export: entities with a fixed timestamp (library, structure) can now have a timezone west of UTC. Upon import, any year xx<=69 is converted to 20xx (Y2K handling) - was xx<=70 before, which includes the unix epoch.
• Bugfix in NewlineStringCollector: += did not properly support a list of items (ipkiss.io.collector)

### Picazzo¶

• [Backward incompatible] All occurences of LayerProperty have been removed on picazzo components - the process and purpose properties should be used instead. This affects trace templates, photonic crystals, MMIs and grating couplers.
• [Backward incompatible] Cleanup of technology. Importing the technology is now done using from technologies import silicon_photonics.
• If you have designs/scripts in IPKISS 3.0 syntax that uses si_photonics, please change your script to use silicon_photonics
• If you have a custom technology that is based on si_photonics, it will still work with components based on IPKISS 2.4 syntax (in backward compatibility mode). But if you want to use your custom technology in IPKISS3, it is better to base it on the silicon_photonics technology files.
• Added trace bundles and waveguide bundles, which group a set of traces/waveguides routed together. The layout can have a covering hull.
• Added electrical wires (traces.electrical_wire) and contact vias (electrical.contact)
• The Y splitters in picazzo3.wg.splitters now have a Caphe model (transmission + 3 reflection parameters)
• Added TerminatePorts, ExtendPorts, FanoutPorts, TransitionPorts, RoutePortsEastWest, RoutePortAroundCorner. Added a notebook on containers (samples/notebook3/containers). Each type of container also has a ‘generic’ version where the properties of each port can be adjusted.
• Refactored PlaceAndAutoRoute: the functionality has been separated into individual PCells: PlaceComponents, ConnectComponents, and PlaceAndConnect. You can now use this functionality in a granular way. Also, it is now possible to explicitly name the external ports.
• Added MMI filters, models have been added. ‘Shallow’ (picazzo2) has been renamed to ‘Rib’. For example, ShallowMMI2x2Tapered is now called RibMMI2x2Tapered.
• Added Mach-Zehnder Interferometers. A set of circuit simulation samples for the picazzo MZIs can be found under samples/ipkiss3/picazzo3/mzi.
• Added Curved Grating Couplers. There are 2 classes (FiberCouplerCurvedGratingGeneric and FiberCouplerCurvedGrating). All the functionality previously accessible in picazzo2 is accessible from these 2 classes. Examples in the picazzo reference documentation. There is also a dedicated notebook (ipkiss3\Curved Grating Couplers.ipynb).
• Added reflection to grating coupler models. The fiber port is now called vertical_in by default.
• Added Spirals. Includes a bugfix where expanding the spiral in the vertical direction would sometimes be wrong. Please check the reference documentation, and the dedicated notebook (ipkiss3\Waveguide spirals.ipynb)
• Added IOFibCoup adapter, which allows to automatically connect fiber couplers to a PCell. Many improvements compared to picazzo in 2.4 were added, including better architecture, improved error handling. For an overview of the features, please check the reference documentation, or the notebook (ipkiss3/IOFibcoup - Routing to fibercouplers.ipynb).
• The models for the directional couplers now include the phase propagation of the arms. Please check the reference documentation for more information.
• Added phase modulator waveguide templates: P(I)N junction based phase modulator, lateral and longitudinal, and a generic base class.
• Added a phase modulator PCell.

### Simulation¶

• CAMFR: Removed hard-coded wavelength restriction.
• Caphe: fixed bug where setup time for a complex circuit with many levels of hierarchy and many number of ports took a lot of time to load (exponential with the number of hierarchy levels). This is now linear in time.
• Caphe: throw an exception if the type of a property value of a CapheModel changes. Make sure to always use strongly typed properties such as IntProperty and NumberProperty, or ensure that a DefinitionProperty of a CapheModel always returns a value of the same type.

### i-Python notebooks¶

• [Backward incompatible] The IPython Notebooks are now based on version 3 of the notebook framework. Your old notebooks should work fine when you load them, but you will have to add %pylab inline at the beginning. when saved, they will be in the new format.
• Added several new demonstration notebooks on containers, grating couplers, IoFibcoup, ...

### Ipkiss 2.4 compatibility¶

• Ipkiss 2.4 Structures now automatically get a netlist, deriving terms for the Structure’s ports. This makes it easier to use a library with Ipkiss 2.4 Structures as children in Ipkiss 3 PCells.
• New technologies (like silicon_photonics) will only support Ipkiss 3 PCells. If you want to use Ipkiss 2.4 Structures with a new-style technology you need to import the compat24 technology immediately after you have imported your technology.
• Trace transitions should not be mixed with waveguide tapers from Ipkiss 2.4.

## Ipkiss 3.0¶

Most parts of IPKISS are rewritten in IPKISS 3.0, and new functionality has been added. The most notable changes are summarized below:

### Functionality¶

• The Caphe circuit solver is now integrated, and circuit simulations can be launched from within Ipkiss
• A new framework for describing PCells and their Views has been written
• Parametric cells can now also contain netlist and circuit model information
• A number of components from the picazzo library were ported to the new syntax and have a netlist and circuit model (picazzo3 library)
• A backward compatibility layer with 2.4 has been foreseen. There are a few Backward incompatible changes (documented).

### User experience¶

• The installation infrastructure has been revamped. On Windows, a self-contained installer is available, on Linux packages are available.
• The documentation has been revamped and sufficiently expanded.

### Under the hood¶

• A new property framework (strong typing/caching) was adopted.