-
Notifications
You must be signed in to change notification settings - Fork 48
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
add fdtdx repo #17
base: master
Are you sure you want to change the base?
add fdtdx repo #17
Conversation
Reviewer's Guide by SourceryThis PR adds a reference to the fdtdx repository in the README.md file. The change is a simple addition to the list of FDTD (Finite-Difference Time-Domain) simulation tools. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @frederikschubert - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a brief description of fdtdx's key features (like inverse design capabilities) to match the style of other entries in the list
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
@@ -99,6 +99,7 @@ If you are new to Git and Python I recommend reading this [article](https://ligh | |||
- [Python 3D FDTD simulator](https://github.com/flaport/fdtd) - Written in PyTorch. | |||
- tidy3d client [docs](https://docs.simulation.cloud/projects/tidy3d/en/latest/) and [code](https://github.com/flexcompute/tidy3d) - Server is propietary. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (typo): There's a typo in 'propietary' - it should be 'proprietary'
@@ -99,6 +99,7 @@ If you are new to Git and Python I recommend reading this [article](https://ligh | |||
- [Python 3D FDTD simulator](https://github.com/flaport/fdtd) - Written in PyTorch. | |||
- tidy3d client [docs](https://docs.simulation.cloud/projects/tidy3d/en/latest/) and [code](https://github.com/flexcompute/tidy3d) - Server is propietary. | |||
- [GSvit](http://gsvit.net/) - GPU support | |||
- [fdtdx](https://github.com/ymahlau/fdtdx) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: Consider adding brief distinguishing characteristics for fdtdx
Other entries in this list include brief descriptions of key features or implementation details. Adding similar information for fdtdx would maintain consistency and help users quickly compare different tools.
fdtdx
is a FDTD engine and inverse design suite that enables the flexible optimization of 3D photonic devices.Summary by Sourcery
Documentation: