-
Notifications
You must be signed in to change notification settings - Fork 29
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 Coils and magnetic fields to docs api #615
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #615 +/- ##
==========================================
+ Coverage 94.30% 94.32% +0.01%
==========================================
Files 77 77
Lines 17696 17696
==========================================
+ Hits 16689 16691 +2
+ Misses 1007 1005 -2
|
black format the doc code |
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.
update example code to have black formatting
normal=[0, 0, 1], | ||
r_n=R_coil, | ||
modes=[0], | ||
grid=LinearGrid(N=100), |
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.
FYI, I'm not sure about having grid
objects assigned to each coil. I was considering getting rid of it in #583 but felt we should discuss it first. I think it would be better to add something like source_grid
as an optional argument to compute_magnetic_field
, especially since after #583 whatever grid you assign to the coil won't be used by the underlying Curve.compute
method.
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.
No description provided.