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

Tutorial polar coordinates #180

Merged
merged 22 commits into from
May 24, 2024
Merged

Tutorial polar coordinates #180

merged 22 commits into from
May 24, 2024

Conversation

sfmig
Copy link
Contributor

@sfmig sfmig commented May 17, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?
We wanted to add a tutorial with an example use of polar coordinates.

What does this PR do?
\

References

Closes #160

How has this PR been tested?

The docs build locally and on CI

Is this a breaking change?

No

Does this PR require an update to the documentation?

No

Checklist:

  • The code has been tested locally
  • [ n/a ] Tests have been added to cover all new functionality
  • [ n/a ] The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

Copy link

codecov bot commented May 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.68%. Comparing base (b2de775) to head (60a7ffa).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #180   +/-   ##
=======================================
  Coverage   99.68%   99.68%           
=======================================
  Files          11       11           
  Lines         638      638           
=======================================
  Hits          636      636           
  Misses          2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sfmig sfmig marked this pull request as ready for review May 21, 2024 19:28
@sfmig sfmig requested a review from niksirbi May 21, 2024 20:08
Copy link
Member

@niksirbi niksirbi left a comment

Choose a reason for hiding this comment

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

Thanks a lot @sfmig 🎉!

This looks good, I just had a few clarifying questions and some optional suggestions.

Also, two thoughts came to mind:

  • @b-peri is working on implementing head direction as a derived variable. Once we have that, we should edit the first half of this example to use our implementation.
  • In your examples, you go at great lengths to produce detailed and informative plots, but this take lots of matplotlib code. Perhaps we should wrap the most useful such plots as movement.plot utilities, for our (and the users) convenience. Trajectory is the obvious one here. To be clear, this is feature idea for the future (not for this PR).

examples/compute_polar_coordinates.py Outdated Show resolved Hide resolved
examples/compute_polar_coordinates.py Show resolved Hide resolved
examples/compute_polar_coordinates.py Outdated Show resolved Hide resolved
examples/compute_polar_coordinates.py Outdated Show resolved Hide resolved
examples/compute_polar_coordinates.py Show resolved Hide resolved
examples/compute_polar_coordinates.py Outdated Show resolved Hide resolved
examples/compute_polar_coordinates.py Show resolved Hide resolved
examples/compute_polar_coordinates.py Show resolved Hide resolved
examples/compute_polar_coordinates.py Outdated Show resolved Hide resolved
examples/compute_polar_coordinates.py Outdated Show resolved Hide resolved
Copy link
Member

@niksirbi niksirbi left a comment

Choose a reason for hiding this comment

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

Thanks a lot @sfmig !!
I'm very happy with how this looks now, just two minor comments, and after that ready to merge.

examples/compute_polar_coordinates.py Outdated Show resolved Hide resolved
examples/compute_polar_coordinates.py Outdated Show resolved Hide resolved
examples/compute_polar_coordinates.py Outdated Show resolved Hide resolved
Copy link

Quality Gate Passed Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@sfmig sfmig added this pull request to the merge queue May 24, 2024
Merged via the queue into main with commit ffa7311 May 24, 2024
17 checks passed
@sfmig sfmig deleted the smg/polar-tutorial branch May 24, 2024 13:48
@sfmig sfmig mentioned this pull request Dec 3, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document usage of kinematics in polar coordinates
2 participants