Skip to content

PerturbedEquilibrium - DOCS - Identify the surface displacement and correct Glasser citations - #540

Merged
matt-pharr merged 1 commit into
developfrom
docs/xi-s-surface-displacement-20261019
Oct 28, 2026
Merged

matt-pharr merged 1 commit into
developfrom
docs/xi-s-surface-displacement-20261019

Conversation

@krystophny

@krystophny krystophny commented Oct 19, 2026 •

Copy link
Copy Markdown
Collaborator

Identify xi_s as the surface displacement defined by Glasser (2016), Eqs. 9 and 18, and correct the two swapped Glasser article identifiers.

Release note

  • Audience: developers
  • Numerical impact: none (harness @ 9552d66)
  • Migration: none

Regression report

Full documentation build and targeted internal-docstring render passed. Native solovev_n1: all 22 tracked quantities unchanged.

Notes for reviewers

The formatter also normalized three existing lines in the touched Julia file.

Chris&AI

@krystophny

Copy link
Copy Markdown
Collaborator Author

Rebased onto develop 23ff553 and marked ready with a reviewer requested; the release note now carries the harness stamp the convention check requires.

Chris&AI

@matt-pharr

Copy link
Copy Markdown
Collaborator

@krystophny I disagree with the inclusion of any symbolic scripts in this repo, that is not what this repo is for. Beyond that, I do not understand the purpose of the derivation of a conversion from pmodb to boozer/hamada gauges that is not implemented in the code here. I do agree with and appreciate the correction of article numbers. What does Chris sans AI think?

@krystophny

Copy link
Copy Markdown
Collaborator Author

@matt-pharr Chris sans AI is sorry that this slipped through. I remove it.

@krystophny
krystophny force-pushed the docs/xi-s-surface-displacement-20261019 branch from 8abdfa6 to 9552d66 Compare October 27, 2026 17:20
@krystophny krystophny changed the title PerturbedEquilibrium - DOCS - Identify surface displacement and document field-strength gauges PerturbedEquilibrium - DOCS - Identify the surface displacement and correct Glasser citations Oct 27, 2026
@krystophny krystophny self-assigned this Oct 28, 2026

@matt-pharr matt-pharr left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the correction and the quick response!

@matt-pharr
matt-pharr merged commit 057c4af into develop Oct 28, 2026
12 of 13 checks passed
@matt-pharr
matt-pharr deleted the docs/xi-s-surface-displacement-20261019 branch October 28, 2026 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants