Metadata-Version: 2.5
Name: cspdk
Version: 2.1.0
Summary: CornerStone PDK
Author-email: gdsfactory <contact@gdsfactory.com>
License: The MIT License (MIT)
        
        Copyright (c) 2024 gdsfactory
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: cornerstone,cspdk,eda,gdsfactory,pdk,photonics,python
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: <3.15,>=3.12
Requires-Dist: circulax>=0.2.3
Requires-Dist: gdsfactoryplus
Requires-Dist: gdsfactory~=9.51.0
Requires-Dist: gplugins[femwell,sax,tidy3d]~=2.1.0
Requires-Dist: klujax>=0.5.1
Provides-Extra: dev
Requires-Dist: doroutes; extra == 'dev'
Requires-Dist: jsondiff; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-github-actions-annotate-failures; extra == 'dev'
Requires-Dist: pytest-regressions; extra == 'dev'
Requires-Dist: tbump; extra == 'dev'
Requires-Dist: towncrier; extra == 'dev'
Provides-Extra: docs
Requires-Dist: jupyter; extra == 'docs'
Requires-Dist: kwasm; extra == 'docs'
Requires-Dist: mkdocs-material; extra == 'docs'
Requires-Dist: mkdocs-with-pdf; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.27.0; extra == 'docs'
Requires-Dist: nbconvert; extra == 'docs'
Requires-Dist: zensical<0.1.0,>=0.0.40; extra == 'docs'
Description-Content-Type: text/markdown


# CORNERSTONE PDK 2.1.0

The University of Southampton's CORNERSTONE silicon photonics platform, a 220nm SOI multi-project-wafer process built for accessible, low-cost prototyping.

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


![](https://i.imgur.com/V5Ukc6j.png)

[CORNERSTONE](https://www.cornerstone.sotonfab.co.uk/) Photonics PDK.

## Supported Process Variants

| Module | Process | Waveguide | Wavelength | Heaters |
|--------|---------|-----------|------------|---------|
| `cspdk.si220` | SOI 220nm | Strip + Rib | C-band / O-band | Yes |
| `cspdk.si340` | SOI 340nm | Strip + Rib | C-band / O-band | Yes |
| `cspdk.si500` | SOI 500nm | Rib | C-band (O-band `_ro` cells have no foundry data) | Yes |
| `cspdk.sin300` | SiN 300nm | Strip | C-band / O-band | Yes |
| `cspdk.sin200` | SiN 200nm | Strip | Visible (520/638/780nm) | Yes |
| `cspdk.ge_on_si` | Ge-on-Si | Rib | Mid-IR (3800nm) | No |
| `cspdk.si_sus` | Suspended Si | Suspended | Mid-IR (3800nm) | No |

Every variant includes SAX circuit models for its optical cells.

## 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 cspdk --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/cspdk.git
cd cspdk
uv venv --python 3.12
uv sync --extra docs --extra dev
```

## Documentation

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

## 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
```
This triggers the release workflow that builds wheels and uploads them.

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