Skip to content
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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

frederikschubert
Copy link

@frederikschubert frederikschubert commented Dec 4, 2024

fdtdx is a FDTD engine and inverse design suite that enables the flexible optimization of 3D photonic devices.

Summary by Sourcery

Documentation:

  • Add a link to the fdtdx repository in the README file.

Copy link

sourcery-ai bot commented Dec 4, 2024

Reviewer's Guide by Sourcery

This 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

Change Details Files
Added a new FDTD simulation tool reference to the documentation
  • Added fdtdx GitHub repository link to the list of FDTD simulators
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a 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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
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.
Copy link

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)
Copy link

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.

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

Successfully merging this pull request may close these issues.

1 participant