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 a gallery example for the frames that depend on Earth's magnetic dipole #7490

Open
wtbarnes opened this issue Mar 11, 2024 · 4 comments
Open
Labels
coordinates Affects the coordinates submodule Documentation Affects the documentation Effort Low Requires a small time investment Examples Affects the Example Gallery Feature Request New feature wanted! Package Novice Requires little knowledge of the internal structure of SunPy Solar Physics Knowledge This requires some basic understanding of solar physics

Comments

@wtbarnes
Copy link
Member

wtbarnes commented Mar 11, 2024

In v5.1, three new frames that depend on Earth's magnetic dipole were added: https://docs.sunpy.org/en/stable/whatsnew/5.1.html#coordinate-frames-related-to-the-earth-s-magnetic-dipole. However, we don't have an example that shows how to actually do anything with these frames. We should add a gallery example (or maybe even a how-to guide?) that gives an example of how to create a frame and then create a coordinate in that existing frame.

@wtbarnes wtbarnes added Feature Request New feature wanted! Documentation Affects the documentation coordinates Affects the coordinates submodule Effort Low Requires a small time investment Examples Affects the Example Gallery labels Mar 11, 2024
@Jett-Code
Copy link
Contributor

A galley example should include coordinates plotted by these new frames, that's it?

@nabobalis
Copy link
Contributor

I think we need to work out exactly what we want the example to do, @ayshih do you have some suggestions?

@nabobalis nabobalis added Package Novice Requires little knowledge of the internal structure of SunPy Solar Physics Knowledge This requires some basic understanding of solar physics labels Mar 20, 2024
@IcyArse
Copy link

IcyArse commented Mar 29, 2024

If I am correct we should just include code snippets demonstrating each coordinate frame and 'how to use them' example, considering definitions for all the parameters is already present in the documentation we shouldn't need explanation for them. Giving us clear and concise code examples.

@nabobalis
Copy link
Contributor

nabobalis commented Mar 29, 2024

If I am correct we should just include code snippets demonstrating each coordinate frame and 'how to use them' example, considering definitions for all the parameters is already present in the documentation we shouldn't need explanation for them. Giving us clear and concise code examples.

The idea behind an example is to try and explain and provide context to what is going on and why values might be chosen for example. It is more than just a few code blocks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
coordinates Affects the coordinates submodule Documentation Affects the documentation Effort Low Requires a small time investment Examples Affects the Example Gallery Feature Request New feature wanted! Package Novice Requires little knowledge of the internal structure of SunPy Solar Physics Knowledge This requires some basic understanding of solar physics
Projects
None yet
Development

No branches or pull requests

4 participants