Skip to content

Fix f_profile definition in EFITEquilibrium docstring and changelog. #356

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.

Sign up for GitHub

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

Merged
jacklovell merged 1 commit into from
Jan 31, 2022
Merged

Fix f_profile definition in EFITEquilibrium docstring and changelog. #356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Release 1.4.0 (TBD)
-------------------

New:
* Make f_profile (toroidal flux) a read-only attribute of EFITEquilibrium. (#355)
* Make f_profile (current flux) a read-only attribute of EFITEquilibrium. (#355)

Release 1.3.0 (8 Dec 2021)
--------------------------
Expand Down
2 changes: 1 addition & 1 deletion cherab/tools/equilibrium/efit.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ cdef class EFITEquilibrium:

:ivar Function2D psi: The poloidal flux in the r-z plane, :math:`\psi(r,z)`.
:ivar Function2D psi_normalised: The normalised poloidal flux in the r-z plane, :math:`\psi_n(r,z)`.
:ivar Function1D f_profile: The toroidal flux at the specified normalised poloidal flux, :math:`F(\psi_n)`.
:ivar Function1D f_profile: The current flux at the specified normalised poloidal flux, :math:`F(\psi_n)`.
:ivar Function1D q: The safety factor :math:`q` at the specified normalised poloidal flux, :math:`q(\psi_n)`.
:ivar VectorFunction2D b_field: A 2D function that returns the magnetic field vector at the specified
point in the r-z plane, :math:`B(r, z)`.
Expand Down