ubcpdk 1.0.4

UBC Siepic Ebeam PDK from edx course

# UBCpdk 1.0.4

[](https://mybinder.org/v2/gh/gdsfactory/ubc/HEAD) [](https://pypi.org/project/ubcpdk/) [](https://github.com/gdsfactory/ubc/issues)   [](https://choosealicense.com/licenses/mit/) [](https://codecov.io/gh/gdsfactory/ubc) [](https://github.com/psf/black)

UBC SiEPIC Ebeam PDK from [edx course](https://www.edx.org/course/silicon-photonics-design-fabrication-and-data-ana)

This is a gdsfactory-based pdk, which provides a fully scripted python based flow for the edx course.

## Documentation

• run notebooks on [](https://mybinder.org/v2/gh/gdsfactory/ubc/HEAD)

• [UBCpdk docs](https://gdsfactory.github.io/ubc/) and [code](https://github.com/gdsfactory/ubc)

• [gdsfactory docs](https://gdsfactory.github.io/gdsfactory/)

• [miniforge install instructions](https://github.com/conda-forge/miniforge#mambaforge)

## Installation

### Installation for users

If you are on Windows, I recommend you install gdspy with Anaconda3, Miniconda3 or [mambaforge](https://github.com/conda-forge/miniforge#mambaforge) (faster conda alternative) and pip for gdsfactory.

` mamba install gdspy -y pip install ubcpdk --upgrade gf tool install `

If you want to get all the extras (mode solvers, meep, circuit simulation …)

` mamba install gdspy -y mamba install pymeep=*=mpi_mpich_* -y pip install ubcpdk[full] --upgrade gf tool install `

Mamba is a faster alternative to conda, if you don’t want to install mamba, you can also replace mamba install gdspy -y with conda install -c conda-forge gdspy -y

If you use linux or MacOs you can install directly from pip pip install ubcpdk specify a specific version pip install ubcpdk==1.0.4 and update to the latest version with pip install ubcpdk –upgrade

I also recommend you install the gdsfactory link to klayout gf tool install

### Installation for developers

For developers you need to git clone the GitHub repository, fork it, git add, git commit, git push and merge request your changes.

` git clone https://github.com/gdsfactory/ubc.git cd ubc pip install -r requirements.txt --upgrade pip install -r requirements_dev.txt --upgrade pip install pre-commit pre-commit install python install_tech.py gf tool install `

## Acks

UBCpdk top contributors:

• Lukas Chrostowski (UBC professor): creator of the course and maintainer of the PDK cells

• Joaquin Matres (Google): maintainer of gdsfactory

• Alex Tait (Queens University): maintainer of lygadgets

Open source heroes:

• Matthias Köfferlein (Germany): for Klayout

• Lucas Heitzmann (University of Campinas, Brazil): for gdspy

• Adam McCaughan (NIST): for phidl

• Alex Tait (Queens University): for lytest

• Thomas Ferreira de Lima (NEC): for pip install klayout

Links:

• [UBC docs](https://gdsfactory.github.io/ubc/) and [repo](https://github.com/gdsfactory/ubc)

• [gdsfactory docs](https://gdsfactory.github.io/gdsfactory/)

• [miniforge install instructions](https://github.com/conda-forge/miniforge#mambaforge)

• [edx course](https://www.edx.org/course/silicon-photonics-design-fabrication-and-data-ana)

• [siepic Ebeam PDK](https://github.com/lukasc-ubc/SiEPIC_EBeam_PDK)

• [awesome photonics list](https://github.com/joamatab/awesome_photonics)