Skip to content

Commit 1608da8

Browse files
committed
Replacing the gf180 module with small wrapper.
* Add a dependency on `gf180mcu` module and redirect imports of `gf180` to that module. * Mark the module as deprecated, and people should use the `gf180mcu` name. * Make the documentation to explain deprecation and redirect to the `gf180mcu` version.
1 parent 2719d89 commit 1608da8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+359
-20031
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# CHANGELOG
22

3+
## 0.1.1 (2025-05-24)
4+
5+
- **DEPRECATED**: This package is now deprecated in favor of gf180mcu
6+
- Converted package to be a thin wrapper/alias for gf180mcu
7+
- All functionality now redirects to gf180mcu
8+
- Added deprecation warnings
9+
- Removed implementation files, keeping only the necessary redirection
10+
311
## 0.0.3
412

513
- update to gdsfactory 7

README.md

Lines changed: 3 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,7 @@
1-
# gf180 0.1.1
1+
# gf180 0.1.1 (Legacy/Deprecated)
22

33
GlobalFoundries 180nm MCU based on [Google open source PDK](https://github.com/google/globalfoundries-pdk-libs-gf180mcu_fd_pr)
44

5-
This is a pure python implementation of the PDK.
5+
**IMPORTANT: This package is now a legacy alias for the `gf180mcu` package. Please use `gf180mcu` directly in new code.**
66

7-
## Installation
8-
9-
We recommend `uv`
10-
11-
```bash
12-
# On macOS and Linux.
13-
curl -LsSf https://astral.sh/uv/install.sh | sh
14-
```
15-
16-
```bash
17-
# On Windows.
18-
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
19-
```
20-
21-
### Installation for users
22-
23-
Use python3.10, 3.11 or 3.12. We recommend [VSCode](https://code.visualstudio.com/) as an IDE.
24-
25-
```
26-
uv pip install cspdk --upgrade
27-
```
28-
29-
Then you need to restart Klayout to make sure the new technology installed appears.
30-
31-
### Installation for contributors
32-
33-
For developers you need to `git clone` the GitHub repository, fork it, git add, git commit, git push and merge request your changes.
34-
35-
```
36-
git clone https://github.com/gdsfactory/gf180.git
37-
cd gf180
38-
uv venv --python 3.11
39-
uv sync --extra docs --extra dev
40-
```
41-
42-
## Documentation
43-
44-
- [gdsfactory docs](https://gdsfactory.github.io/gdsfactory/)
7+
This package now simply redirects all functionality to the `gf180mcu` package. It is kept for backwards compatibility only and will be removed in a future version.

docs/_config.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Book settings
22
# Learn more at https://jupyterbook.org/customize/config.html
33

4-
title: gf180
4+
title: gf180 (DEPRECATED)
55
author: gdsfactory
6+
description: "DEPRECATED: This package is deprecated and will be removed in a future version. Please use gf180mcu instead."
67
# Force re-execution of notebooks on each build.
78
# See https://jupyterbook.org/content/execute.html
89
execute:

docs/_static/redirect.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
window.setTimeout(function () {
2+
let new_url = location.href.replace('gf180', 'gf180mcu');
3+
console.log('Redirecting to', new_url);
4+
location.href = new_url;
5+
}, 5000);

docs/_toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
format: jb-book
55
root: index
66
chapters:
7+
- file: deprecation_notice
78
- file: cells
89
- file: tutorial
910
sections:

0 commit comments

Comments
 (0)