Documentation for gLayout - #111
Conversation
Nimok15 lvs parser
Nimok15 lvs parser
Nimok15 lvs parser
Nimok15 lvs parser
Nimok15 patch 6
| Glayout is a powerful layout automation tool that generates DRC-clean circuit layouts for any technology implementing the Glayout framework. It is implemented as an easy-to-install Python package with all dependencies available on PyPI. | ||
|
|
||
| Key features: | ||
| - PDK-agnostic layout generation |
There was a problem hiding this comment.
Not sure if required to change - by * as they are equally valid for markdown
|
|
||
| ### Basic Installation | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
I think is better defining the language for the highlighting. Not sure why this needed to be deleted.
| python tests/sim/run_cell_sim.py --pdk sky130 --all | ||
|
|
||
| # Results land in lvs_results/ and sim_results/ | ||
| ``` |
There was a problem hiding this comment.
pending to add the CI for simulation. Maybe this is better to merge befor the sim CI is approved.
| [`tests/sim/testbenches/`](tests/sim/testbenches) and the pass criteria in | ||
| [`checks.json`](tests/sim/testbenches/checks.json). | ||
|
|
||
| <!-- TODO: replace the values below with the numbers from your latest CI run --> |
There was a problem hiding this comment.
This will be a good addition for automatic checks. I've seen that in other repos, but not sure how to implement. Maybe good to research it.
| return df_in.flatten() | ||
|
|
||
| def diff_pair_netlist(fetL: Component, fetR: Component, pdk: Optional[MappedPDK] = None, dum_net: Optional[str] = None) -> Netlist: | ||
| def diff_pair_netlist(fetL: Component, fetR: Component, pdk: Optional[MappedPDK] = None, dum_net: Optional[str] = None, substrate_tap: bool = True) -> Netlist: |
There was a problem hiding this comment.
Are these changes required as part of the documentation PR? maybe we can split it in another PR to keep focus just in documentation.
| * - ``guard_ring`` | ||
| - Well/substrate isolation ring around an arbitrary bounding box | ||
| * - ``tapring`` | ||
| - Tap ring for latch-up prevention |
There was a problem hiding this comment.
it is mising the resistor, the mimcap and the bjts
|
Hi Prof. @msaligane @Nimok15 I've reviewed the PR. I think it looks great. Just a few comments about:
In general I think it is in a good shape, but maybe is good a second look perhaps from @AL-255. I'd also may recommend checking the pydata-sphinx-theme (used by gdsfactory) instead just to see the difference. Thanks, |
|
Just another comment, maybe the documentation files should live under docs folder instead of sphinx |
|
Just an update: seems that gdsfactory uses zensical, which is another static documentation site generator, different than sphinx. It looks interesting, however, not sure if worth changing to it. Something interesting it has is the interactive block execution by readers: https://zensical.org/docs/setup/extensions/markdown-exec/ |
3 participants
No description provided.