-
Notifications
You must be signed in to change notification settings - Fork 45
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 inkstone #15
base: master
Are you sure you want to change the base?
add inkstone #15
Conversation
add inkstone
Reviewer's Guide by SourceryThis pull request adds a new entry to the README.md file, including a reference to the 'inkstone' library in the list of electromagnetic 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 @benvial - I've reviewed your changes - here's some feedback:
Overall Comments:
- Could you please add a brief description of 'inkstone' and confirm that it fits well in this section of the README? This would help users understand its functionality and ensure proper categorization.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 1 issue found
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
@@ -112,6 +112,7 @@ If you are new to Git and Python I recommend reading this [article](https://ligh | |||
- [S4](https://github.com/victorliu/S4) | |||
- [grcwa](https://github.com/weiliangjinca/grcwa) - automatic differentiation included with autograd | |||
- [nannos](https://nannos.gitlab.io) - support for multiple backends (numpy/autograd/torch/jax) | |||
- [inkstone](https://github.com/alexysong/inkstone) |
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 (documentation): Consider adding a brief description for inkstone
To maintain consistency with other entries in the list, it would be helpful to include a short description of what inkstone does or its key features.
- [inkstone](https://github.com/alexysong/inkstone) | |
- [inkstone](https://github.com/alexysong/inkstone) - Python package for simulating electromagnetic scattering from layered structures |
add inkstone
Summary by Sourcery
Documentation: