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

Write a tutorial for computing kinematic variables #114

Closed
niksirbi opened this issue Feb 9, 2024 · 1 comment
Closed

Write a tutorial for computing kinematic variables #114

niksirbi opened this issue Feb 9, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@niksirbi
Copy link
Member

niksirbi commented Feb 9, 2024

Is your feature request related to a problem? Please describe.
After #3 is merged, we need a way to document the new features.

Describe the solution you'd like
We can make a new "example", similar to the one we already have, made with sphinx-gallery.
The example will load one of our datasets, and will walk users through computing the various kinematic variables, and going back-and-forth between cartesian and polar coordinate systems.

This should be also accompanied by adding the new functions to the API reference.

Additional context
We also need a "glossary" (see #69), where we give exact definitions of the variables we deal with and establish the nomenclature. But this should/may be a separate PR.

@niksirbi niksirbi added the documentation Improvements or additions to documentation label Feb 9, 2024
@niksirbi niksirbi moved this from 🤔 Triage to ⚠️ Priority in movement progress tracker Feb 9, 2024
@niksirbi niksirbi added this to the v0.1 - alpha release milestone Feb 9, 2024
@niksirbi niksirbi moved this from ⚠️ Priority to 🚧 In Progress in movement progress tracker Mar 18, 2024
@niksirbi niksirbi moved this from 🚧 In Progress to ✅ Done in movement progress tracker Mar 21, 2024
@lochhh
Copy link
Collaborator

lochhh commented Apr 5, 2024

Closing as completed in #135

@lochhh lochhh closed this as completed Apr 5, 2024
@sfmig sfmig removed this from the v0.1 - alpha release milestone Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

3 participants