gdsfactory


Namegdsfactory JSON
Version 8.26.2 PyPI version JSON
download
home_pageNone
Summarypython library to generate GDS layouts
upload_time2024-12-20 01:12:36
maintainerNone
docs_urlNone
authorNone
requires_python<3.14,>=3.10
licenseNone
keywords eda photonics python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # GDSFactory 8.26.2

[![docs](https://github.com/gdsfactory/gdsfactory/actions/workflows/pages.yml/badge.svg)](https://gdsfactory.github.io/gdsfactory/)
[![PyPI](https://img.shields.io/pypi/v/gdsfactory)](https://pypi.org/project/gdsfactory/)
[![PyPI Python](https://img.shields.io/pypi/pyversions/gdsfactory.svg)](https://pypi.python.org/pypi/gdsfactory)
[![Downloads](https://static.pepy.tech/badge/gdsfactory)](https://pepy.tech/project/gdsfactory)
[![MIT](https://img.shields.io/github/license/gdsfactory/gdsfactory)](https://choosealicense.com/licenses/mit/)
[![codecov](https://img.shields.io/codecov/c/github/gdsfactory/gdsfactory)](https://codecov.io/gh/gdsfactory/gdsfactory/tree/main/gdsfactory)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/gdsfactory/binder-sandbox/HEAD)

> 🚀 **Notice: Major Release**
>
> We are excited to announce that GDSFactory has upgraded its backend from gdstk to KLayout. This change brings enhanced routing functions and additional features from KLayout, including DRC, dummy fill, and connectivity checks.
>
> Notice that the routing and some advanced functions have changed. For a complete list of changes, please refer to our [migration guide](https://gdsfactory.github.io/gdsfactory/notebooks/21_migration_guide_7_8.html) or review the updated layout tutorial.

GDSFactory is a powerful Python library for designing a wide range of complex systems, including photonic circuits, analog devices, quantum components, MEMs, 3D printed objects, and PCBs. With GDSFactory, you can create and refine your designs using Python or YAML, perform rigorous verification through Design Rule Checking (DRC), Layout Versus Schematic (LVS) checks, and simulations. Additionally, it facilitates automated lab testing to ensure that your fabricated devices meet precise specifications, streamlining the entire design-to-fabrication workflow.


As input you write python code, as an output GDSFactory creates CAD files (GDS, OASIS, STL, GERBER).

![cad](https://i.imgur.com/3cUa2GV.png)

```python
import gdsfactory as gf

c = gf.Component()
ref1 = c.add_ref(gf.components.rectangle(size=(10, 10), layer=(1, 0)))
ref2 = c.add_ref(gf.components.text("Hello", size=10, layer=(2, 0)))
ref3 = c.add_ref(gf.components.text("world", size=10, layer=(2, 0)))

ref1.xmax = ref2.xmin - 5
ref3.xmin = ref2.xmax + 2
ref3.rotate(30)
c.show()
```

Highlights:

- +2M downloads
- +70 Contributors
- +15 PDKs available

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

We provide a comprehensive end-to-end design flow that enables you to:

- **Design (Layout, Simulation, Optimization)**: Define parametric cell functions in Python to generate components. Test component settings, ports, and geometry to avoid unwanted regressions, and capture design intent in a schematic.
- **Verify (DRC, DFM, LVS)**: Run simulations directly from the layout using our simulation interfaces, removing the need to redraw your components in simulation tools. Conduct component and circuit simulations, study design for manufacturing. Ensure complex layouts match their design intent through Layout Versus Schematic verification (LVS) and are DRC clean.
- **Validate**: Define layout and test protocols simultaneously for automated chip analysis post-fabrication. This allows you to extract essential component parameters, and build data pipelines from raw data to structured data to monitor chip performance.

Your input: Python or YAML text.
Your output: A GDSII or OASIS file for fabrication, alongside component settings (for measurement and data analysis) and netlists (for circuit simulations) in YAML.

We provide a common syntax for design (Ansys, Lumerical, Tidy3d, MEEP, DEVSIM, SAX, MEOW, Xyce ...), verification, and validation.

![tool interfaces](https://i.imgur.com/j5qlFWj.png)

Numerous foundries offer GDSFactory PDKs that are accessible under an NDA. To gain access to these PDKs, please send proof of your NDA to contact@gdsfactory.com

- AIM photonics PDK
- AMF photonics PDK
- Compoundtek photonics PDK
- GlobalFoundries 45SPCLO Photonics PDK
- HHI Photonics PDK
- IMEC photonics PDK
- Smart Photonics Photonics PDK
- TowerSemi PH18 photonics PDK
- III-V Labs PDK
- Lionix PDK

Coming soon:

- Ligentec PDK
- Lightium PDK

There are also open source PDKs available without an NDA:

- [GlobalFoundries 180nm MCU CMOS PDK](https://gdsfactory.github.io/gf180/)
- [ANT / SiEPIC Ebeam UBC PDK](https://gdsfactory.github.io/ubc)
- [Skywater130 CMOS PDK](https://gdsfactory.github.io/skywater130)
- [VTT](https://github.com/gdsfactory/vtt)
- [Cornerstone](https://github.com/gdsfactory/cspdk)
- [Luxtelligence](https://github.com/Luxtelligence/lxt_pdk_gf)

## Getting started

- [See slides](https://docs.google.com/presentation/d/1_ZmUxbaHWo_lQP17dlT1FWX-XD8D9w7-FcuEih48d_0/edit#slide=id.g11711f50935_0_5)
- [Read docs](https://gdsfactory.github.io/gdsfactory/)
- [![Video Tutorials](https://img.shields.io/badge/youtube-Video_Tutorials-red.svg?logo=youtube)](https://www.youtube.com/@gdsfactory/playlists)
- [![Join the chat at https://gitter.im/gdsfactory-dev/community](https://badges.gitter.im/gdsfactory-dev/community.svg)](https://gitter.im/gdsfactory-dev/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
- See announcements on [GitHub](https://github.com/gdsfactory/gdsfactory/discussions/547), [google-groups](https://groups.google.com/g/gdsfactory) or [LinkedIn](https://www.linkedin.com/company/gdsfactory)
- [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=250169028)
- [PIC training](https://gdsfactory.github.io/gdsfactory-photonics-training/)
- Online course [UBCx: Silicon Photonics Design, Fabrication and Data Analysis](https://www.edx.org/learn/engineering/university-of-british-columbia-silicon-photonics-design-fabrication-and-data-ana), where students can use GDSFactory to create a design, have it fabricated, and tested.

## Who is using GDSFactory?

Hundreds of organisations are using GDSFactory. Some companies and organizations around the world using GDSFactory include:

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

"I've used **GDSFactory** since 2017 for all my chip tapeouts. I love that it is fast, easy to use, and easy to extend. It's the only tool that allows us to have an end-to-end chip design flow (design, verification and validation)."

<div style="text-align: right; margin-right: 10%;">Joaquin Matres - <strong>Google</strong></div>

---

"I've relied on **GDSFactory** for several tapeouts over the years. It's the only tool I've found that gives me the flexibility and scalability I need for a variety of projects."

<div style="text-align: right; margin-right: 10%;">Alec Hammond - <strong>Meta Reality Labs Research</strong></div>

---

"The best photonics layout tool I've used so far and it is leaps and bounds ahead of any commercial alternatives out there. Feels like GDSFactory is freeing photonics."

<div style="text-align: right; margin-right: 10%;">Hasitha Jayatilleka - <strong>LightIC Technologies</strong></div>

---

"As an academic working on large scale silicon photonics at CMOS foundries I've used GDSFactory to go from nothing to full-reticle layouts rapidly (in a few days). I particularly appreciate the full-system approach to photonics, with my layout being connected to circuit simulators which are then connected to device simulators. Moving from legacy tools such as gdspy and phidl to GDSFactory has sped up my workflow at least an order of magnitude."

<div style="text-align: right; margin-right: 10%;">Alex Sludds - <strong>MIT</strong></div>

---

"I use GDSFactory for all of my photonic tape-outs. The Python interface makes it easy to version control individual photonic components as well as entire layouts, while integrating seamlessly with KLayout and most standard photonic simulation tools, both open-source and commercial.

<div style="text-align: right; margin-right: 10%;">Thomas Dorch - <strong>Freedom Photonics</strong></div>

## Why use GDSFactory?

- It's fast, extensible and easy to use.
- It's free, as in freedom and in cost.
- It's the most popular EDA tool with a growing community of users, developers, and extensions to other tools.

GDSFactory is really fast thanks to KLayout C++ library for manipulating GDSII objects. You will notice this when reading/writing big GDS files or doing large boolean operations.

| Benchmark      |  gdspy  | GDSFactory | Gain |
| :------------- | :-----: | :--------: | :--: |
| 10k_rectangles | 80.2 ms |  4.87 ms   | 16.5 |
| boolean-offset | 187 μs  |  44.7 μs   | 4.19 |
| bounding_box   | 36.7 ms |   170 μs   | 216  |
| flatten        | 465 μs  |  8.17 μs   | 56.9 |
| read_gds       | 2.68 ms |   94 μs    | 28.5 |

## Contributors

Thanks to all the contributors that make this awesome project possible!

![contributors](https://i.imgur.com/0AuMHZE.png)


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "gdsfactory",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.10",
    "maintainer_email": null,
    "keywords": "eda, photonics, python",
    "author": null,
    "author_email": "gdsfactory community <contact@gdsfactory.com>",
    "download_url": "https://files.pythonhosted.org/packages/3a/ee/03a1e976528620147daaf80dfa1251cd159b95c555a331afe492b5dd2f5c/gdsfactory-8.26.2.tar.gz",
    "platform": null,
    "description": "# GDSFactory 8.26.2\n\n[![docs](https://github.com/gdsfactory/gdsfactory/actions/workflows/pages.yml/badge.svg)](https://gdsfactory.github.io/gdsfactory/)\n[![PyPI](https://img.shields.io/pypi/v/gdsfactory)](https://pypi.org/project/gdsfactory/)\n[![PyPI Python](https://img.shields.io/pypi/pyversions/gdsfactory.svg)](https://pypi.python.org/pypi/gdsfactory)\n[![Downloads](https://static.pepy.tech/badge/gdsfactory)](https://pepy.tech/project/gdsfactory)\n[![MIT](https://img.shields.io/github/license/gdsfactory/gdsfactory)](https://choosealicense.com/licenses/mit/)\n[![codecov](https://img.shields.io/codecov/c/github/gdsfactory/gdsfactory)](https://codecov.io/gh/gdsfactory/gdsfactory/tree/main/gdsfactory)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/gdsfactory/binder-sandbox/HEAD)\n\n> \ud83d\ude80 **Notice: Major Release**\n>\n> We are excited to announce that GDSFactory has upgraded its backend from gdstk to KLayout. This change brings enhanced routing functions and additional features from KLayout, including DRC, dummy fill, and connectivity checks.\n>\n> Notice that the routing and some advanced functions have changed. For a complete list of changes, please refer to our [migration guide](https://gdsfactory.github.io/gdsfactory/notebooks/21_migration_guide_7_8.html) or review the updated layout tutorial.\n\nGDSFactory is a powerful Python library for designing a wide range of complex systems, including photonic circuits, analog devices, quantum components, MEMs, 3D printed objects, and PCBs. With GDSFactory, you can create and refine your designs using Python or YAML, perform rigorous verification through Design Rule Checking (DRC), Layout Versus Schematic (LVS) checks, and simulations. Additionally, it facilitates automated lab testing to ensure that your fabricated devices meet precise specifications, streamlining the entire design-to-fabrication workflow.\n\n\nAs input you write python code, as an output GDSFactory creates CAD files (GDS, OASIS, STL, GERBER).\n\n![cad](https://i.imgur.com/3cUa2GV.png)\n\n```python\nimport gdsfactory as gf\n\nc = gf.Component()\nref1 = c.add_ref(gf.components.rectangle(size=(10, 10), layer=(1, 0)))\nref2 = c.add_ref(gf.components.text(\"Hello\", size=10, layer=(2, 0)))\nref3 = c.add_ref(gf.components.text(\"world\", size=10, layer=(2, 0)))\n\nref1.xmax = ref2.xmin - 5\nref3.xmin = ref2.xmax + 2\nref3.rotate(30)\nc.show()\n```\n\nHighlights:\n\n- +2M downloads\n- +70 Contributors\n- +15 PDKs available\n\n![workflow](https://i.imgur.com/KyavbHh.png)\n\nWe provide a comprehensive end-to-end design flow that enables you to:\n\n- **Design (Layout, Simulation, Optimization)**: Define parametric cell functions in Python to generate components. Test component settings, ports, and geometry to avoid unwanted regressions, and capture design intent in a schematic.\n- **Verify (DRC, DFM, LVS)**: Run simulations directly from the layout using our simulation interfaces, removing the need to redraw your components in simulation tools. Conduct component and circuit simulations, study design for manufacturing. Ensure complex layouts match their design intent through Layout Versus Schematic verification (LVS) and are DRC clean.\n- **Validate**: Define layout and test protocols simultaneously for automated chip analysis post-fabrication. This allows you to extract essential component parameters, and build data pipelines from raw data to structured data to monitor chip performance.\n\nYour input: Python or YAML text.\nYour output: A GDSII or OASIS file for fabrication, alongside component settings (for measurement and data analysis) and netlists (for circuit simulations) in YAML.\n\nWe provide a common syntax for design (Ansys, Lumerical, Tidy3d, MEEP, DEVSIM, SAX, MEOW, Xyce ...), verification, and validation.\n\n![tool interfaces](https://i.imgur.com/j5qlFWj.png)\n\nNumerous foundries offer GDSFactory PDKs that are accessible under an NDA. To gain access to these PDKs, please send proof of your NDA to contact@gdsfactory.com\n\n- AIM photonics PDK\n- AMF photonics PDK\n- Compoundtek photonics PDK\n- GlobalFoundries 45SPCLO Photonics PDK\n- HHI Photonics PDK\n- IMEC photonics PDK\n- Smart Photonics Photonics PDK\n- TowerSemi PH18 photonics PDK\n- III-V Labs PDK\n- Lionix PDK\n\nComing soon:\n\n- Ligentec PDK\n- Lightium PDK\n\nThere are also open source PDKs available without an NDA:\n\n- [GlobalFoundries 180nm MCU CMOS PDK](https://gdsfactory.github.io/gf180/)\n- [ANT / SiEPIC Ebeam UBC PDK](https://gdsfactory.github.io/ubc)\n- [Skywater130 CMOS PDK](https://gdsfactory.github.io/skywater130)\n- [VTT](https://github.com/gdsfactory/vtt)\n- [Cornerstone](https://github.com/gdsfactory/cspdk)\n- [Luxtelligence](https://github.com/Luxtelligence/lxt_pdk_gf)\n\n## Getting started\n\n- [See slides](https://docs.google.com/presentation/d/1_ZmUxbaHWo_lQP17dlT1FWX-XD8D9w7-FcuEih48d_0/edit#slide=id.g11711f50935_0_5)\n- [Read docs](https://gdsfactory.github.io/gdsfactory/)\n- [![Video Tutorials](https://img.shields.io/badge/youtube-Video_Tutorials-red.svg?logo=youtube)](https://www.youtube.com/@gdsfactory/playlists)\n- [![Join the chat at https://gitter.im/gdsfactory-dev/community](https://badges.gitter.im/gdsfactory-dev/community.svg)](https://gitter.im/gdsfactory-dev/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n- See announcements on [GitHub](https://github.com/gdsfactory/gdsfactory/discussions/547), [google-groups](https://groups.google.com/g/gdsfactory) or [LinkedIn](https://www.linkedin.com/company/gdsfactory)\n- [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=250169028)\n- [PIC training](https://gdsfactory.github.io/gdsfactory-photonics-training/)\n- Online course [UBCx: Silicon Photonics Design, Fabrication and Data Analysis](https://www.edx.org/learn/engineering/university-of-british-columbia-silicon-photonics-design-fabrication-and-data-ana), where students can use GDSFactory to create a design, have it fabricated, and tested.\n\n## Who is using GDSFactory?\n\nHundreds of organisations are using GDSFactory. Some companies and organizations around the world using GDSFactory include:\n\n![logos](https://i.imgur.com/VzLNMH1.png)\n\n\"I've used **GDSFactory** since 2017 for all my chip tapeouts. I love that it is fast, easy to use, and easy to extend. It's the only tool that allows us to have an end-to-end chip design flow (design, verification and validation).\"\n\n<div style=\"text-align: right; margin-right: 10%;\">Joaquin Matres - <strong>Google</strong></div>\n\n---\n\n\"I've relied on **GDSFactory** for several tapeouts over the years. It's the only tool I've found that gives me the flexibility and scalability I need for a variety of projects.\"\n\n<div style=\"text-align: right; margin-right: 10%;\">Alec Hammond - <strong>Meta Reality Labs Research</strong></div>\n\n---\n\n\"The best photonics layout tool I've used so far and it is leaps and bounds ahead of any commercial alternatives out there. Feels like GDSFactory is freeing photonics.\"\n\n<div style=\"text-align: right; margin-right: 10%;\">Hasitha Jayatilleka - <strong>LightIC Technologies</strong></div>\n\n---\n\n\"As an academic working on large scale silicon photonics at CMOS foundries I've used GDSFactory to go from nothing to full-reticle layouts rapidly (in a few days). I particularly appreciate the full-system approach to photonics, with my layout being connected to circuit simulators which are then connected to device simulators. Moving from legacy tools such as gdspy and phidl to GDSFactory has sped up my workflow at least an order of magnitude.\"\n\n<div style=\"text-align: right; margin-right: 10%;\">Alex Sludds - <strong>MIT</strong></div>\n\n---\n\n\"I use GDSFactory for all of my photonic tape-outs. The Python interface makes it easy to version control individual photonic components as well as entire layouts, while integrating seamlessly with KLayout and most standard photonic simulation tools, both open-source and commercial.\n\n<div style=\"text-align: right; margin-right: 10%;\">Thomas Dorch - <strong>Freedom Photonics</strong></div>\n\n## Why use GDSFactory?\n\n- It's fast, extensible and easy to use.\n- It's free, as in freedom and in cost.\n- It's the most popular EDA tool with a growing community of users, developers, and extensions to other tools.\n\nGDSFactory is really fast thanks to KLayout C++ library for manipulating GDSII objects. You will notice this when reading/writing big GDS files or doing large boolean operations.\n\n| Benchmark      |  gdspy  | GDSFactory | Gain |\n| :------------- | :-----: | :--------: | :--: |\n| 10k_rectangles | 80.2 ms |  4.87 ms   | 16.5 |\n| boolean-offset | 187 \u03bcs  |  44.7 \u03bcs   | 4.19 |\n| bounding_box   | 36.7 ms |   170 \u03bcs   | 216  |\n| flatten        | 465 \u03bcs  |  8.17 \u03bcs   | 56.9 |\n| read_gds       | 2.68 ms |   94 \u03bcs    | 28.5 |\n\n## Contributors\n\nThanks to all the contributors that make this awesome project possible!\n\n![contributors](https://i.imgur.com/0AuMHZE.png)\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "python library to generate GDS layouts",
    "version": "8.26.2",
    "project_urls": null,
    "split_keywords": [
        "eda",
        " photonics",
        " python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0d3fb7ced3f227af02275150258c75d86757051247252e55e8e3e1b71b8bdd65",
                "md5": "713e120183506a0a3d019626ee9563a4",
                "sha256": "03439dd13ea495738d300e67fe79a3949129f0e2ee03470e8e8e514dbed2ffe8"
            },
            "downloads": -1,
            "filename": "gdsfactory-8.26.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "713e120183506a0a3d019626ee9563a4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.10",
            "size": 659559,
            "upload_time": "2024-12-20T01:12:33",
            "upload_time_iso_8601": "2024-12-20T01:12:33.928952Z",
            "url": "https://files.pythonhosted.org/packages/0d/3f/b7ced3f227af02275150258c75d86757051247252e55e8e3e1b71b8bdd65/gdsfactory-8.26.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3aee03a1e976528620147daaf80dfa1251cd159b95c555a331afe492b5dd2f5c",
                "md5": "8757948e3fa803643469b5cd4c0cd2d0",
                "sha256": "e354348411d3b7e0a109e57951808268b449e8cb5389e360dc0b251ad2a2de94"
            },
            "downloads": -1,
            "filename": "gdsfactory-8.26.2.tar.gz",
            "has_sig": false,
            "md5_digest": "8757948e3fa803643469b5cd4c0cd2d0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.14,>=3.10",
            "size": 470073,
            "upload_time": "2024-12-20T01:12:36",
            "upload_time_iso_8601": "2024-12-20T01:12:36.916547Z",
            "url": "https://files.pythonhosted.org/packages/3a/ee/03a1e976528620147daaf80dfa1251cd159b95c555a331afe492b5dd2f5c/gdsfactory-8.26.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-20 01:12:36",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "gdsfactory"
}
        
Elapsed time: 0.44484s