Generic Process Design Kit for Gdsfactory

Generic Process Design Kit for Gdsfactory
Table of contents

Introduction

The generic open source PDK is a collaboration between Mabrains and Gdsfactory to provide a fully open source process design kit (PDK) and related resources to enable the creation of photonic designs manufacturable.

Current-Status

⚠️ We are currently treating the current content as an experimental preview!

The PDK will be tagged with a production version when ready to do production design.

Generic-PDK

This repository contains the full pdk inspired from Gdsfactory generic technology.

This includes:

Schematic symbols
DRC
LVS
Pcells

Currently it supports;

For Schematic:
- Xschem
For DRC/LVS/Pcells:
- Klayout

Prerequisites

At a minimum:

python 3.10+
python3-venv
klayout 0.28.14+
xschem V3.1.0+

Installation

To begin, create a new directory that will contain all GenericPDK setup files and environment configurations:

mkdir generic_pdk_setup && cd generic_pdk_setup/

Next, clone the project into the current directory you have created:

git clone https://github.com/mabrains/gdsfactory-generic-pdk

Afterward, you will need to create a python virtual environment:

python3 -m venv ./generic_pdk_env && source ./generic_pdk_env/bin/activate

And then:

cd gdsfactory-generic-pdk

"Subsequently, to install the required Python packages, execute the following command:

pip install -r requirements.txt

Lastly, to install the Generic-PDK for the KLayout tool, execute the following commands:

python3 install_tech.py --tech_path=$PWD/klayout/ --klayout_home=$PWD/../generic_pdk_klayout --python_env=$PWD/../generic_pdk_env/

This will install the Generic-PDK technology in the KLayout tool. You can then open it by executing the following command:

Note: Open a new terminal before executing the following command.

klayout_generic_pdk

Alternatively, to open a pre-existing layout, you can use the following command:

klayout_generic_pdk <your_layout_file>

Example:

klayout_generic_pdk klayout/lvs/testing/testcases/unit/lidar_device/lidar.gds

You will observe that the PDK has been added to KLayout, as illustrated in Figure 1.

Fig. 1. Klayout Generic-PDK Loaded

Usage

Please refer to xschem-symbols for more information about symbols usage.

Please refer to klayout for more information about DRC/LVS/PCells usage.

About Mabrains

Mabrains was founded to achieve the main purpose to change the world of Chip Design using AI. Empowering the world with a new methodologies and techniques that would disrupt the status quo in the EDA industry.

We have contributed in developing many PDKs for Open Source Tools. For more information, please refer to Mabrains-Github.

Contact-Us

Requests for more information about Generic PDK and other open source technologies can be submitted via this web form.

License

The Generic PDK is released under the GNU Lesser General Public License - Version 3

The copyright details (which should also be found at the top of every file) are;

# SPDX-FileCopyrightText: 2024 Mabrains Company
# Licensed under the GNU Lesser General Public License, Version 3.0 (the "License");
# you may not use this file except in compliance with the License.

#                    GNU Lesser General Public License
#                       Version 3, 29 June 2007

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
# SPDX-License-Identifier: LGPL-3.0

nikosavola / gdsfactory-generic-pdk