-
Notifications
You must be signed in to change notification settings - Fork 15
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
Separatrix operational space #12
Conversation
9babfa0
to
d280364
Compare
d280364
to
e380774
Compare
e380774
to
2f8c82d
Compare
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.
There are a few functions that don't document their inputs, and I've not commented on all of them. I'm not sure that every single formula needs to have detailed docstrings with glossary link, but those that you export via your __init__.py
should.
) | ||
alpha_c = calc_critical_MHD_parameter_alpha_c(elongation=elongation_psi95, triangularity=triangularity_psi95) | ||
|
||
poloidal_circumference = 2.0 * np.pi * minor_radius * (1 + 0.55 * (elongation_psi95 - 1)) * (1 + 0.08 * triangularity_psi95**2) |
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.
Where does this formula come from? And why is it different compared to the poloidal_circumference
in separatrix_operational_space.auxillaries.poloidal circumference
?
Adds the model from https://iopscience.iop.org/article/10.1088/1741-4326/ac0412
[x] Adds an example case corresponding to the paper
[x] Adds a notebook demonstrating how to use
[x] Adds unit tests and increases coverage
[x] Verify that results match implementation in paper
[x] Adds new variables to physics glossary