From 0af7ff96d6aab7560265286fcf0f7675b99185a8 Mon Sep 17 00:00:00 2001 From: Dario Panici Date: Tue, 15 Oct 2024 13:51:32 -0400 Subject: [PATCH 1/2] add reference to from_qp_model --- desc/geometry/surface.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/desc/geometry/surface.py b/desc/geometry/surface.py index 2f74200aa..9bfa51267 100644 --- a/desc/geometry/surface.py +++ b/desc/geometry/surface.py @@ -350,6 +350,8 @@ def from_qp_model( ): """Create a surface from a near-axis model for quasi-poloidal symmetry. + Model is based off of section III of Goodman et. al. [1]_ + Parameters ---------- major_radius : float @@ -376,6 +378,11 @@ def from_qp_model( surface : FourierRZToroidalSurface Surface with given geometric properties. + References + ---------- + .. [1] Goodman, Alan, et al. "Constructing Precisely Quasi-Isodynamic + Magnetic Fields." Journal of Plasma Physics 89.5 (2023): 905890504. + """ assert mirror_ratio <= 1 a = major_radius * np.sqrt(elongation) / aspect_ratio # major axis From 9d89c4055d0accecf0700daafa2f484cbdae3c32 Mon Sep 17 00:00:00 2001 From: Dario Panici Date: Tue, 15 Oct 2024 14:18:26 -0400 Subject: [PATCH 2/2] fix doc syntax --- desc/geometry/surface.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/desc/geometry/surface.py b/desc/geometry/surface.py index 9bfa51267..817eee4a1 100644 --- a/desc/geometry/surface.py +++ b/desc/geometry/surface.py @@ -381,7 +381,7 @@ def from_qp_model( References ---------- .. [1] Goodman, Alan, et al. "Constructing Precisely Quasi-Isodynamic - Magnetic Fields." Journal of Plasma Physics 89.5 (2023): 905890504. + Magnetic Fields." Journal of Plasma Physics 89.5 (2023): 905890504. """ assert mirror_ratio <= 1