Merge pull request #115 from nikosavola/palace-scattering-docs-improv…

…ements Improve RF simulation docs formatting slightly
gdsfactory · Sep 13, 2023 · 77e749b · 77e749b
2 parents 3c07fee + 244fedb
commit 77e749b
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 9 deletions.
diff --git a/docs/notebooks/elmer_01_electrostatic.py b/docs/notebooks/elmer_01_electrostatic.py
@@ -36,7 +36,6 @@
 # ## Geometry, layer config and materials
 
 # %% tags=["hide-input"]
-
 import os
 from math import inf
 from pathlib import Path
@@ -112,7 +111,6 @@
 # ```
 
 # %% tags=["hide-output"]
-
 results = run_capacitive_simulation_elmer(
     c,
     layer_stack=layer_stack,

diff --git a/docs/notebooks/palace_01_electrostatic.py b/docs/notebooks/palace_01_electrostatic.py
@@ -33,7 +33,6 @@
 # ## Geometry, layer config and materials
 
 # %% tags=["hide-input"]
-
 import os
 from math import inf
 from pathlib import Path
@@ -109,7 +108,7 @@
 #    The meshing parameters and element order shown here are very lax. As such, the computed capacitances are not very accurate.
 # ```
 
-# %%
+# %% tags=["hide-output"]
 results = run_capacitive_simulation_palace(
     c,
     layer_stack=layer_stack,

diff --git a/docs/notebooks/palace_02_fullwave.py b/docs/notebooks/palace_02_fullwave.py
@@ -29,7 +29,7 @@
 # This effectively solves the scattering parameters for the terminals.
 #
 # In this notebook, we the same interdigital capacitor as in {doc}`palace_01_electrostatic.py` but add lumped ports to the geometry.
-# Afterwards, the capacitance matrix can be computed from the scattering parameters as described in {eq}`s_to_y_to_c`.
+# Afterwards, the capacitance matrix can be computed from the scattering parameters as described in Eq. {eq}`s_to_y_to_c`.
 #
 # ## Installation
 # See [Palace – Installation](https://awslabs.github.io/palace/stable/install/) for installation or compilation instructions. Gplugins assumes `palace` is available in your PATH environment variable.
@@ -43,8 +43,7 @@
 #
 # ## Geometry, layer config and materials
 
-# %%
-
+# %% tags=["hide-input"]
 import os
 from math import inf
 from pathlib import Path
@@ -113,7 +112,6 @@
 c.show()
 
 # %%
-
 # Add lumped port rectangles manually, see examples for https://awslabs.github.io/palace/stable/examples/cpw/
 lumped_port_1_1 = gf.components.bbox(((-40, 11), (-46, 5)), layer=LAYER.PORT)
 lumped_port_1_2 = gf.components.bbox(((-40, -11), (-46, -5)), layer=LAYER.PORT)
@@ -143,7 +141,7 @@
 # %%
 help(run_scattering_simulation_palace)
 
-# %%
+# %% tags=["hide-output"]
 results = run_scattering_simulation_palace(
     c,
     layer_stack=layer_stack,