Metadata-Version: 2.4
Name: cspdk
Version: 1.4.3
Summary: CornerStone PDK
Keywords: python
Author-email: gdsfactory <contact@gdsfactory.com>
Requires-Python: >=3.12,<3.15
Description-Content-Type: text/markdown
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
License-File: LICENSE
Requires-Dist: gdsfactory~=9.43.0
Requires-Dist: gplugins[sax, femwell, tidy3d]~=2.1.0
Requires-Dist: doroutes~=0.6.0
Requires-Dist: gdsfactoryplus ; 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"
Requires-Dist: jupyter ; 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


# CORNERSTONE PDK 1.4.3

<!-- 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.

## 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

```bash
make pre-commit
```

## 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.

