Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/solgaardlab/dphox
https://github.com/solgaardlab/dphox
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/solgaardlab/dphox
- Owner: solgaardlab
- License: mit
- Created: 2021-06-22T21:15:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-14T07:50:04.000Z (over 2 years ago)
- Last Synced: 2024-08-04T03:06:21.538Z (5 months ago)
- Language: Python
- Size: 4.07 MB
- Stars: 16
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome_photonics - dphox - includes 3D MEMs structures (layout)
README
DPhox
# DPhox 0.0.8
The `dphox` module is yet another Python 3-based design tool for automating photonic device development.
**Note**: This is a work in progress. Expect features in the code to be unstable until version `0.1.0`. Note the low
test coverage, which will be improved in coming weeks.
## [Documentation and tutorials](https://dphox.readthedocs.io/en/latest/)
The [documentation](https://dphox.readthedocs.io/en/latest/) contains the API reference for `dphox`
and the tutorials you need to get started.
We also provide a number of Colab tutorials to introduce the basics:
1. [**Photonic design**](https://colab.research.google.com/gist/sunilkpai/a74439194069bf9538ccc828c6227836/00_photonics.ipynb#scrollTo=25f87704-e435-4ff5-8b1c-3453ec30c330)
2. Fundamentals: the core classes `dp.Pattern` and `dp.Curve` and various transformations / examples.
3. Design workflow: concepts for designing a chip in an automated fabless workflow.
# Why `dphox`?
## Gallery
## Advantages of `dphox`
- Efficient raw `numpy` implementations for polygon and curve transformations
- Dependence on [`shapely`](https://shapely.readthedocs.io/en/stable/manual.html)
in favor of [`pyclipper`](https://pypi.org/project/pyclipper/) (less actively maintained).
- `dphox.Curve` ~ `shapely.geometry.MultiLineString`
- `dphox.Pattern` ~ `shapely.geometry.MultiPolygon`
- The [`klamath`](https://mpxd.net/code/jan/klamath/src/branch/master/klamath/elements.py) module
provides a clean implementation of GDS I/O
- Uses `trimesh` for 3D viewing/export, `blender` figures at your fingertips!
- Plotting using [`holoviews`](https://holoviews.org/) and [`bokeh`](http://docs.bokeh.org/en/latest/),
allowing zoom in/out in a notebook.
- More intuitive representation of GDS cell hierarchy (via `Device`).
- Interface to photonic simulation (such as [`simphox`](https://github.com/fancompute/simphox)
and [`MEEP`](https://meep.readthedocs.io/)).
- Inverse-designed devices may be incorporated via the `Pattern.replace` function.
- Read and interface with foundry PDKs automatically, even if provided via GDS.
## Inspirations for `dphox`
- [`phidl`](https://phidl.readthedocs.io/en/latest/): path calculations, Inkscape-like maneuverability,
functional interface.
- [`nazca`](https://nazca-design.org): ports, cell references, and routing.
- [`gdspy`](https://gdspy.readthedocs.io/en/stable/): parametric implementations, the OG of python GDS automation
# Installation
## Getting started
You may use `pip` to install `dphox` the usual way:
```
pip install dphox
```
To install all of the dependencies for visualizations as in the above demo, instead run:
```
pip install dphox[all]
```
## Development
When developing, install in your python environment using:
```
git clone [email protected]:solgaardlab/dphox.git
pip install -e dphox
```
You can then change `dphox` if necessary. When importing `dphox`, you can now treat it as any other module. No filepath
setting necessary because `dphox` will be in your environment's `site-packages` directory.
## Requirements
You will need `python>=3.9` as well as the following (note these requirements are automatically installed):
```
numpy==1.21.2
scipy==1.7.1
shapely==1.7.0
klamath>=1.2
```
These will be installed via `pip` automatically if not already installed.
## Optional requirements
The following modules are nice-to-have but optional, and are not included in default installation:
```
bokeh==2.2.3
holoviews==1.14.6
trimesh==3.9.30
triangle==20200424
matplotlib==3.4.3
networkx
```
You can also install libraries such as `nazca` and `gdspy`, which can be converted to
`dphox` objects.