Skip to content

Updating import gds tutorial #321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Conversation

FilipeFcp
Copy link
Contributor

Hi @tomflexcompute

I split it into two notebooks, but we can delete the one about creating the file if you think it is not necessary.

I also added the files for the Multipole Expansion notebook to the JSON mapping. I learned about it from your comment on the Yuanshen notebook.

Copy link
Contributor

github-actions bot commented Jul 2, 2025

Spell Check Report

GDSImport.ipynb:

Cell 7, Line 3: 'dtypes'
  > For a simple case, we can iterate through the polygons and inspect the layers and dtypes.

Checked 2 notebook(s). Found spelling errors in 1 file(s).
Generated by GitHub Action run: https://github.com/flexcompute/tidy3d-notebooks/actions/runs/16036177150

Copy link
Contributor

@e-g-melo e-g-melo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @FilipeFcp! This new organization is very helpful.

GDSCreation.ipynb

  1. I suggest renaming this notebook to "Layout design using gdstk" or something similar.
  2. Maybe you could modify this sentence a bit to avoid starting it with a variable "sidewall_angle > 0 corresponds to a typical fabrication scenario where the base of the device is larger than the top."
  3. I think we don't have an example of a simple directional coupler simulation (only that broadband one). Maybe we could use this layout to add a new one.

GDSImport.ipynb

  1. I also suggest modifying this sentence to avoid starting it with a variable name: "sidewall_angle > 0 corresponds to a typical fabrication scenario where the base of the device is larger than the top."
  2. "into a tidy3d.Simulation as td.Structures with..." -> "into a td.Simulation as td.Structures with..."

Copy link
Contributor

@tomflexcompute tomflexcompute left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @FilipeFcp . The splitting makes sense.

  1. In the GDSCreation notebook, the title still reads "Importing GDS files".
  2. In the GDSCreation notebook, maybe also mention PhotonForge as our own layout tool.
  3. Please update the rst files for the new notebook.

@FilipeFcp
Copy link
Contributor Author

Thank you all for the comments.
@e-g-melo , do you mean adding the simulation to the same notebook, or creating a separate notebook for it?
I'm slightly leaning toward a separate notebook that imports the GDS, focuses on the simulation, and includes links to the two tutorials.

@e-g-melo
Copy link
Contributor

e-g-melo commented Jul 3, 2025

@e-g-melo , do you mean adding the simulation to the same notebook, or creating a separate notebook for it?
I'm slightly leaning toward a separate notebook that imports the GDS, focuses on the simulation, and includes links to the two tutorials.

Create a separate one.

@daquinteroflex
Copy link
Collaborator

Will this go in 2.9?

@FilipeFcp
Copy link
Contributor Author

@daquinteroflex I didn't know that was relevant for notebooks. Is there something I need to do?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants