Merge pull request #284 from gdsfactory/use_notebooks

use notebooks for ease of use
gdsfactory · Jan 8, 2024 · 8023fff · 8023fff
2 parents 07e3e88 + fddc35c
commit 8023fff
Show file tree

Hide file tree

Showing 101 changed files with 16,194 additions and 9,588 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,10 +12,11 @@ docs/notebooks/batch-*
 *.hdf5
 *.msh
 *.dat
-*.ipynb
 *.gds
 *.pkl
 *.txt
+*.csv
+*.html
 test-data/
 _autosummary/
 gplugins/path_length_analysis/test_pathlength_reporting/
@@ -51,7 +52,6 @@ share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
-*.ipynb
 MANIFEST
 
 # PyInstaller

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -46,3 +46,14 @@ repos:
         types: [file]
         files: \.(j2|yml|yaml)$
         exclude: .github/.*|web|elmer
+  - repo: https://github.com/kynan/nbstripout
+    rev: 0.6.1
+    hooks:
+      - id: nbstripout
+        files: ".ipynb"
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli
diff --git a/Makefile b/Makefile
@@ -1,6 +1,6 @@
-
 install:
 	pip install -e .[dev,docs,devsim,femwell,gmsh,klayout,meow,meshwell,ray,sax,schematic,tidy3d,vlsir]
+	pip install git+https://github.com/gdsfactory/gdsfactory --force-reinstall
 	pre-commit install
 
 dev: test-data gmsh elmer install

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -69,7 +69,7 @@ sphinx:
       "ComponentSpec": "ComponentSpec"
     nb_execution_show_tb: True
     nb_execution_raise_on_error: true
-    nb_custom_formats:
-        .py:
-            - jupytext.reads
-            - fmt: py
+    # nb_custom_formats:
+    #     .py:
+    #         - jupytext.reads
+    #         - fmt: py
diff --git a/docs/notebooks b/docs/notebooks
@@ -0,0 +1 @@
+../notebooks
diff --git a/docs/notebooks/11_get_netlist.py b/docs/notebooks/11_get_netlist.py
diff --git a/docs/notebooks/11_get_netlist_spice.py b/docs/notebooks/11_get_netlist_spice.py