tidy3d-notebooks

December 11, 2025 ยท View on GitHub

You can see our pretty example library documentation to explore each of these notebooks in more detail.

Development Guidance

  • Make sure all your internal API references start with tidy3d.<your_reference>
  • In notebooks, always have absolute links, otherwise the links will break when the user downloads them.
  • The develop branch is syced to the state of the webcenter in order to enable new notebooks to be featured quickly.
  • If you are developing a notebook using a version that is not the latest official version (i.e. 2.9.1 vs the python client develop branch) make sure to merge it only after the python client has been released. Or use a pre/2.10 branch.

These instructions are valid as of Nov 2025, but may change depending on structural planned changes and you can verify with the team.

Common Documentation References

API ResourceURL
Installation Guidehttps://docs.flexcompute.com/projects/tidy3d/en/latest/install.html
Documentationhttps://docs.flexcompute.com/projects/tidy3d/en/latest/index.html
Example Libraryhttps://docs.flexcompute.com/projects/tidy3d/en/latest/notebooks/docs/index.html
FAQhttps://docs.flexcompute.com/projects/tidy3d/en/latest/faq/docs/index.html
NameRepository
Source Codehttps://github.com/flexcompute/tidy3d
Example Notebookshttps://github.com/flexcompute/tidy3d-notebooks
FAQ Source Codehttps://github.com/flexcompute/tidy3d-faq