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

DOC: add a background section to docs #121

Open
aburrell opened this issue Mar 29, 2023 · 1 comment
Open

DOC: add a background section to docs #121

aburrell opened this issue Mar 29, 2023 · 1 comment
Labels
documentation Documentation changes
Milestone

Comments

@aburrell
Copy link
Owner

aburrell commented Mar 29, 2023

Requested feature

It would be nice to have a 'background' section in the documentation that briefly discusses the different coordinate systems, what uses they're good/bad at, and how the secular variation is treated in each of them.

The problem or gap this feature will address

It can be confusing to start using magnetic coordinates, especially when there are so many options.

The desired solution

Add a chapter to the docs. Include this reference:

Quoting @ljlamarche in #115: This article was helpful for understanding what exactly the secular variation code was trying to do. https://earth-planets-space.springeropen.com/articles/10.1186/s40623-021-01507-z

Possible alternatives

Include a section with just useful references for future reading

@aburrell aburrell added enhancement documentation Documentation changes labels Mar 29, 2023
@aburrell aburrell added this to the 2.1.0 milestone Mar 29, 2023
@aburrell aburrell changed the title ENH: Expand documentation DOC: add a background section to docs Mar 29, 2023
@ljlamarche
Copy link
Collaborator

Laundal and Richmond, 2017 is the best all-around reference I've found for this topic, but it's quite long and detailed and a short overview or summary of the relevant parts may be helpful. This may be related to the discussion on #12 about creating a jupyter notebook tutorial for how to properly work with the Apex base vectors. @asreimer and @klaundal, did anything every come of this?

@aburrell aburrell modified the milestones: 2.1.0, 2.1.1 Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes
Projects
None yet
Development

No branches or pull requests

2 participants