Metadata-Version: 2.5
Name: ubcpdk
Version: 3.3.5
Summary: ubcpdk pdk
Keywords: ebeam,eda,foundry,gdsfactory,pdk,photonics,process,python,siepic,ubc
Author-email: gdsfactory <contact@gdsfactory.com>
Requires-Python: >=3.12,<3.13
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
License-File: LICENSE
Requires-Dist: gdsfactory~=9.51.0
Requires-Dist: gplugins[sax, tidy3d]~=2.1.0
Requires-Dist: jsondiff
Requires-Dist: gdsfactoryplus
Requires-Dist: pytz
Requires-Dist: pytest ; extra == "dev"
Requires-Dist: gdsfactoryplus ; extra == "dev"
Requires-Dist: pytest-cov ; extra == "dev"
Requires-Dist: pytest_regressions ; extra == "dev"
Requires-Dist: pytest-github-actions-annotate-failures ; extra == "dev"
Requires-Dist: pre-commit ; extra == "dev"
Requires-Dist: jupyter ; extra == "docs"
Requires-Dist: kwasm==0.3.3 ; extra == "docs"
Requires-Dist: mkdocs-material ; extra == "docs"
Requires-Dist: mkdocs-with-pdf ; extra == "docs"
Requires-Dist: nbconvert ; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.27.0 ; extra == "docs"
Requires-Dist: zensical>=0.0.40,<0.1.0 ; extra == "docs"
Provides-Extra: dev
Provides-Extra: docs
Import-Name: ubcpdk

# ubcpdk (SiEPIC Ebeam PDK) 3.3.4

The University of British Columbia's SiEPIC EBeam PDK is a 220nm SOI silicon photonics platform fabricated via electron-beam lithography, widely used in academia and multi-project-wafer runs.

<!-- BADGES:START -->
[![Docs](https://github.com/gdsfactory/ubc/actions/workflows/pages.yml/badge.svg)](https://github.com/gdsfactory/ubc/actions/workflows/pages.yml)
[![Tests](https://github.com/gdsfactory/ubc/actions/workflows/test_code.yml/badge.svg)](https://github.com/gdsfactory/ubc/actions/workflows/test_code.yml)
[![DRC](https://github.com/gdsfactory/ubc/raw/badges/drc.svg)](https://github.com/gdsfactory/ubc/actions/workflows/drc.yml)
[![Model Regression](https://github.com/gdsfactory/ubc/actions/workflows/model_regression.yml/badge.svg)](https://github.com/gdsfactory/ubc/actions/workflows/model_regression.yml)
[![Test Coverage](https://github.com/gdsfactory/ubc/raw/badges/coverage.svg)](https://github.com/gdsfactory/ubc/actions/workflows/test_coverage.yml)
[![Model Coverage](https://github.com/gdsfactory/ubc/raw/badges/model_coverage.svg)](https://github.com/gdsfactory/ubc/actions/workflows/model_coverage.yml)
[![Issues](https://github.com/gdsfactory/ubc/raw/badges/issues.svg)](https://github.com/gdsfactory/ubc/issues)
[![PRs](https://github.com/gdsfactory/ubc/raw/badges/prs.svg)](https://github.com/gdsfactory/ubc/pulls)
<!-- BADGES:END -->


[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/gdsfactory/binder-sandbox/HEAD)
[![pypi](https://img.shields.io/pypi/v/ubcpdk)](https://pypi.org/project/ubcpdk/)
[![mit](https://img.shields.io/github/license/gdsfactory/ubc)](https://choosealicense.com/licenses/mit/)
[![codecov](https://codecov.io/gh/gdsfactory/ubc/branch/main/graph/badge.svg?token=T3kCV2gYE9)](https://codecov.io/gh/gdsfactory/ubc)
[![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

SiEPIC Ebeam PDK adapted from [siepic Ebeam PDK](https://github.com/lukasc-ubc/SiEPIC_EBeam_PDK) for gdsfactory.
It provides a fully python driven flow alternative for the most advanced users taking the [edx course](https://www.edx.org/course/silicon-photonics-design-fabrication-and-data-ana)

## Installation

We recommend `uv`

```bash
# On macOS and Linux.
curl -LsSf https://astral.sh/uv/install.sh | sh
```

```bash
# On Windows.
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

### Installation for users

Use python 3.11, 3.12 or 3.13. We recommend [VSCode](https://code.visualstudio.com/) as an IDE.

```
uv pip install ubcpdk --upgrade
```

Then you need to restart Klayout to make sure the new technology installed appears.

### Installation for contributors


Then you can install with:

```bash
git clone https://github.com/gdsfactory/ubc.git
cd ubc
uv venv --python 3.12
uv sync --extra docs --extra dev
```

## Documentation

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

## Pre-commit

Pre-commit hooks are centrally maintained in [pdk-ci-workflow-public](https://github.com/doplaydo/pdk-ci-workflow-public). `make dev` fetches the canonical config and installs the git hook.

```bash
make dev
```

## Tests

Run the test suite:

```bash
make test
```

## Release

1. Bump the version:

```bash
tbump 0.0.1
```

2. Push the tag:

```bash
git push --tags
```
This triggers the release workflow that builds wheels and uploads them.

3. Create a pull request with the updated changelog since last release.

