Skip to content
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 topic guide describing rsun idiosyncracies #7000

Merged
merged 16 commits into from Jun 8, 2023

Conversation

alasdairwilson
Copy link
Member

@alasdairwilson alasdairwilson commented May 9, 2023

This takes some of the content from coords regarding rsun and its involvement in transforms/reprojects expands on it and makes a topic guide.

If anyone else can think of additional content that should be here and feedback on current content extremely welcome.

@alasdairwilson alasdairwilson added the Documentation Affects the documentation label May 9, 2023
@alasdairwilson alasdairwilson requested a review from a team as a code owner May 9, 2023 13:30
Copy link
Member

@Cadair Cadair left a comment

Choose a reason for hiding this comment

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

Thanks! This is an excellent use of the topic guide.

docs/guide/rsun.rst Outdated Show resolved Hide resolved
docs/guide/rsun.rst Outdated Show resolved Hide resolved
docs/guide/rsun.rst Outdated Show resolved Hide resolved
@wtbarnes
Copy link
Member

wtbarnes commented May 9, 2023

This will conflict with #6954. I would suggest merging that first since it does additional reorganization as well. It may be that all of the info in that (very incomplete) topic guide is completely redundant compared to the more complete information here.

@nabobalis
Copy link
Contributor

The other PR is now merged.

@nabobalis nabobalis added the backport 5.0 on-merge: backport to 5.0 label May 9, 2023
@alasdairwilson alasdairwilson added the Needs Review Needs reviews before merge label May 29, 2023
Copy link
Contributor

@nabobalis nabobalis left a comment

Choose a reason for hiding this comment

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

Another really minor review

docs/guide/rsun.rst Outdated Show resolved Hide resolved
docs/guide/rsun.rst Outdated Show resolved Hide resolved
docs/guide/rsun.rst Outdated Show resolved Hide resolved
docs/guide/rsun.rst Outdated Show resolved Hide resolved
docs/guide/rsun.rst Outdated Show resolved Hide resolved
docs/guide/rsun.rst Outdated Show resolved Hide resolved
docs/guide/rsun.rst Outdated Show resolved Hide resolved
docs/guide/rsun.rst Outdated Show resolved Hide resolved
docs/guide/rsun.rst Outdated Show resolved Hide resolved
docs/guide/rsun.rst Outdated Show resolved Hide resolved
@nabobalis
Copy link
Contributor

It unfortunately conflicts with main as well now.

Copy link
Member

@ayshih ayshih left a comment

Choose a reason for hiding this comment

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

I don't want to block this PR, but here is the structure and content this topic guide eventually needs to have, which could be deferred to a follow-up PR:

  • The title should be something like "Different values for the radius of the Sun"
  • There ought to be an introduction that explains the radius of the Sun:
Observing in visible wavelengths
The meaning and context of the IAU constant
Observing in wavelengths other than visible (e.g., EUV)
  • The second section should describe the rsun frame attribute
2D coordinates
Converting 2D coordinates to 3D coordinates, with examples
  • The third section should describe how the radius of the Sun is determined for data files
RSUN_REF keyword, or calculated from RSUN_OBS keyword, or default
Why Maps from different data sources might have different `rsun` values for the same emission
Why the precise value of the radius of the Sun typically doesn't matter
  • The fourth section then goes into reprojection

docs/guide/rsun.rst Outdated Show resolved Hide resolved
docs/guide/rsun.rst Outdated Show resolved Hide resolved
@nabobalis
Copy link
Contributor

We should create a tracking issue for Alberys comment.

@nabobalis nabobalis removed the Needs Review Needs reviews before merge label Jun 7, 2023
@alasdairwilson alasdairwilson force-pushed the add_rsun_topic branch 2 times, most recently from 75ffa2d to 28a68e9 Compare June 7, 2023 22:29
alasdairwilson and others added 2 commits June 7, 2023 23:43
Co-authored-by: Nabil Freij <nabil.freij@gmail.com>
@nabobalis nabobalis merged commit 931606d into sunpy:main Jun 8, 2023
20 of 25 checks passed
meeseeksmachine pushed a commit to meeseeksmachine/sunpy that referenced this pull request Jun 8, 2023
nabobalis pushed a commit that referenced this pull request Jun 8, 2023
…idiosyncracies) (#7056)

Co-authored-by: Alasdair Wilson <60351846+alasdairwilson@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 5.0 on-merge: backport to 5.0 Documentation Affects the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants