Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joamatab committed Dec 9, 2024
1 parent d012181 commit f7f95d1
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ notebooks/rib_strip_pathlengths/
gplugins/klayout/d25/
gplugins/klayout/layers.lyp
gplugins/klayout/tech.lyt
notebooks/luminescent_runs/


# C extensions
*.csv
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,15 @@ GDSFactory plugins:
- `lumerical` For Ansys FDTD and Circuit interconnect.
- `klayout` for fill, dataprep and testing.
- `ray` for distributed computing and optimization.
- `sax` S-parameter circuit solver.
- `schematic`: for bokeh schematic editor and `path_length_analysis`.
- `meep` for FDTD.
- `mpb` for MPB mode solver.
- `elmer` for electrostatic (capacitive) simulations.
- `palace` for full-wave driven (S parameter) and electrostatic (capacitive) simulations.
- `sax` S-parameter circuit solver.
- `vlsir` for parsing GDS-extracted circuit netlists into Cadence Spectre, NgSpice and Xyce Schematic File formats.
- `luminescent` for FDTD simulations.


## Installation

Expand Down
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ execute:
- "*meep_*"
- "*meow_01*"
- "*femwell_01_modes*"
- "*luminescent"
# - "*20_schematic_driven_layout*"
# - "*001_meep_sparameters*"
# - "*00_tidy3d.ipynb"
Expand Down
4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@ klayout = [
"vlsir~=6.0",
"vlsirtools~=6.0"
]
luminescent = [
"luminescent~=0.2.12",
"sortedcontainers"
]
maintainer = [
"mypy",
"tbump",
Expand Down
28 changes: 28 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f7f95d1

Please sign in to comment.