Skip to content

adding GUI script visualization tutorial #339

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jul 25, 2025
Merged

adding GUI script visualization tutorial #339

merged 2 commits into from
Jul 25, 2025

Conversation

@FilipeFcp
Copy link
Contributor

@FilipeFcp FilipeFcp commented Jul 24, 2025

Hi @e-g-melo

This is a first version of the notebook. Let me know if it aligns with what you were expecting.

Just for context, @alec-flexcompute, Emerson asked for a guide for users who want to process multiple simulations from a sweep. Since the GUI currently only allows downloading data for up to 10 simulatons at once, he suggested creating a tutorial to help users work with the script generated by the GUI.

Also, Emerson, I have two suggestions for the script:

Add a list of the sweep values to make it easier to create labels when plotting the fields.

Consider including the import statement for matplotlib in the script.

@github-actions
Copy link
Contributor

github-actions bot commented Jul 24, 2025 •
edited
Loading

Spell Check Report

GUIDataTutorial.ipynb:

Cell 1, Line 9: 'll'
  > In this notebook, we’ll walk through tips and examples for post-processing parametric sweep results from the Web GUI using Python. Most code snippets presented here can be easily adapted to your own projects.
Cell 2, Line 10: 'sw-'
  > 'sw-5f2a3905-a835-46ea-9a5b-b33923925b454',
Cell 2, Line 11: 'sw-'
  > 'sw-a05473ab-f17e-4b03-a6c4-53ae3df47f211',
Cell 2, Line 12: 'sw-'
  > 'sw-9494afda-cb41-4c85-815f-a767d86a20805',
Cell 2, Line 13: 'sw-'
  > 'sw-7126922d-64cd-4366-b6fe-1dde9055b4b63',
Cell 2, Line 14: 'sw-'
  > 'sw-a07f0f54-b5f6-4b4b-804b-f5f8b8b3a6940',
Cell 2, Line 15: 'sw-'
  > 'sw-b0d69553-4621-43cc-9f7c-6a4bd856f7c32',
Cell 4, Line 10: 'sw-'
  > "sw-5f2a3905-a835-46ea-9a5b-b33923925b454",
Cell 4, Line 11: 'sw-'
  > "sw-a05473ab-f17e-4b03-a6c4-53ae3df47f211",
Cell 4, Line 12: 'sw-'
  > "sw-9494afda-cb41-4c85-815f-a767d86a20805",
Cell 4, Line 13: 'sw-'
  > "sw-7126922d-64cd-4366-b6fe-1dde9055b4b63",
Cell 4, Line 14: 'sw-'
  > "sw-a07f0f54-b5f6-4b4b-804b-f5f8b8b3a6940",
Cell 4, Line 15: 'sw-'
  > "sw-b0d69553-4621-43cc-9f7c-6a4bd856f7c32",
Cell 6, Line 9: 'sw-'
  > "sw-5f2a3905-a835-46ea-9a5b-b33923925b454",
Cell 6, Line 10: 'sw-'
  > "sw-a05473ab-f17e-4b03-a6c4-53ae3df47f211",
Cell 6, Line 11: 'sw-'
  > "sw-9494afda-cb41-4c85-815f-a767d86a20805",
Cell 6, Line 12: 'sw-'
  > "sw-7126922d-64cd-4366-b6fe-1dde9055b4b63",
Cell 6, Line 13: 'sw-'
  > "sw-a07f0f54-b5f6-4b4b-804b-f5f8b8b3a6940",
Cell 6, Line 14: 'sw-'
  > "sw-b0d69553-4621-43cc-9f7c-6a4bd856f7c32",
Cell 8, Line 13: 'sw-'
  > "sw-5f2a3905-a835-46ea-9a5b-b33923925b454",
Cell 8, Line 14: 'sw-'
  > "sw-a05473ab-f17e-4b03-a6c4-53ae3df47f211",
Cell 8, Line 15: 'sw-'
  > "sw-9494afda-cb41-4c85-815f-a767d86a20805",
Cell 8, Line 16: 'sw-'
  > "sw-7126922d-64cd-4366-b6fe-1dde9055b4b63",
Cell 8, Line 17: 'sw-'
  > "sw-a07f0f54-b5f6-4b4b-804b-f5f8b8b3a6940",
Cell 8, Line 18: 'sw-'
  > "sw-b0d69553-4621-43cc-9f7c-6a4bd856f7c32",
Cell 10, Line 16: 'sw-'
  > "sw-5f2a3905-a835-46ea-9a5b-b33923925b454",
Cell 10, Line 17: 'sw-'
  > "sw-a05473ab-f17e-4b03-a6c4-53ae3df47f211",
Cell 10, Line 18: 'sw-'
  > "sw-9494afda-cb41-4c85-815f-a767d86a20805",
Cell 10, Line 19: 'sw-'
  > "sw-7126922d-64cd-4366-b6fe-1dde9055b4b63",
Cell 10, Line 20: 'sw-'
  > "sw-a07f0f54-b5f6-4b4b-804b-f5f8b8b3a6940",
Cell 10, Line 21: 'sw-'
  > "sw-b0d69553-4621-43cc-9f7c-6a4bd856f7c32",
Cell 13, Line 12: 'sw-'
  > "sw-8738b266-4733-48da-aa13-11b4397872bf1",
Cell 13, Line 13: 'sw-'
  > "sw-e490dc15-217f-49b3-a4f5-0675c92d85b80",
Cell 13, Line 14: 'sw-'
  > "sw-b91352e9-fb81-4880-9394-3399fa724fc13",
Cell 13, Line 15: '-acbf-', 'sw-'
  > "sw-f48edeeb-5372-4bfb-acbf-c7f3199d0fc52",
Cell 16, Line 11: 'sw-'
  > "sw-db60f8aa-3196-4361-b694-48f6100a4b474",
Cell 16, Line 12: 'sw-'
  > "sw-3340fb2a-9627-40f0-a1d0-b5d67128f78914",
Cell 16, Line 13: 'sw-'
  > "sw-8e22ae40-3b92-4221-9bf6-25c9104cd8ec11",
Cell 16, Line 14: 'sw-'
  > "sw-608fd3e1-ad5c-41ca-a382-247268204ffb3",
Cell 16, Line 15: 'sw-'
  > "sw-809cc1e1-0fd5-4f44-8454-fc1aea75df2e1",
Cell 16, Line 16: 'sw-'
  > "sw-0fb58701-c820-4090-a309-ebbda46a86ca12",
Cell 16, Line 17: 'sw-'
  > "sw-6dc7d32b-7ab6-49c3-8f64-168c9a54c8127",
Cell 16, Line 18: 'sw-'
  > "sw-82abae19-4978-47ee-aac8-cb8da40c9e5e13",
Cell 16, Line 19: 'sw-'
  > "sw-6d84d662-542c-46b6-91a6-718f84c12de12",
Cell 16, Line 20: 'sw-'
  > "sw-5402252e-ccf1-46c1-8a89-789f18cffbe910",
Cell 16, Line 21: 'sw-'
  > "sw-dc16e0a9-26c1-4e75-9564-36e6c7bdb05415",
Cell 16, Line 22: 'sw-'
  > "sw-3b550f02-3fa4-46d2-9a75-8f0aec1a3a5e6",
Cell 16, Line 23: 'sw-'
  > "sw-36823176-e570-4ebc-b339-f20ef0ef4b525",
Cell 16, Line 24: 'sw-'
  > "sw-d5bc6181-9e34-4212-a665-87c7be630e718",
Cell 16, Line 25: 'sw-'
  > "sw-723945f8-b3c0-4af6-a902-f204895bdc839",
Cell 16, Line 26: 'sw-'
  > "sw-0c6e28fa-c2bd-49a7-aca9-cb1946b27f210",

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

e-g-melo
e-g-melo approved these changes Jul 24, 2025
View reviewed changes
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! The notebook is amazing!

I will provide the design variable names in the code snippet.

@FilipeFcp
Copy link
Contributor Author

FilipeFcp commented Jul 24, 2025

Thanks @e-g-melo.

I forgot to mention. Will the users have access to these task IDs? If I suffice to share the main simulation, or should I share all the sweeps?

alec-flexcompute
alec-flexcompute approved these changes Jul 24, 2025
View reviewed changes
Copy link
Contributor

@alec-flexcompute alec-flexcompute left a comment

Choose a reason for hiding this comment

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

Great job as always @FilipeFcp - I'll probably copy/paste from this notebook myself. A couple quick things:

  1. "The good news is that you don't need to be a Python expert." -> "Tidy3D users need not be Python experts to do this." The former way colloquially suggests that there's a "bad news" side to "the good news" stated before.

  2. Right above cell one, maybe give a brief (i.e. 1 sentence, nothing technical) explanation of what an "ax" object is.

  3. Link to the actual function (https://docs.flexcompute.com/projects/tidy3d/en/latest/api/_autosummary/tidy3d.components.data.sim_data.AbstractYeeGridSimulationData.html#tidy3d.components.data.sim_data.AbstractYeeGridSimulationData.plot_field) to make it easy to see allowed values for parameters like field_name, val, etc.

  4. (OPTIONAL) Above cell 4, you may want to briefly describe and link to numpy's unwrap function (https://numpy.org/doc/stable/reference/generated/numpy.unwrap.html) which is useful for plotting phases.

@FilipeFcp
Copy link
Contributor Author

FilipeFcp commented Jul 24, 2025

Thanks @alec-flexcompute! Great catches as always.
I actually never used np.unwrap before, it's so convenient. I don't know how I lived so long without it 😄

@tylerflex
Copy link
Collaborator

tylerflex commented Jul 25, 2025

can we merge this?

@FilipeFcp FilipeFcp merged commit 81d35a9 into develop Jul 25, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@e-g-melo e-g-melo e-g-melo approved these changes

@alec-flexcompute alec-flexcompute alec-flexcompute approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@FilipeFcp @tylerflex @e-g-melo @alec-flexcompute