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(kepler-problem): #82 add tutorial #98

Merged
merged 9 commits into from
Sep 25, 2024
Merged

Conversation

emptymalei
Copy link
Member

@emptymalei emptymalei commented Sep 16, 2024

Resolves #82

  • from_geometry: multiple examples to show case the different orbits
    • circular orbit
    • ellipse
    • hyperbolic
    • parabolic
  • use iom
  • Maybe some explanations on how the equation was solved.

@emptymalei emptymalei marked this pull request as draft September 16, 2024 21:15
@emptymalei emptymalei added the documentation Improvements or additions to documentation label Sep 16, 2024
Copy link
Contributor

github-actions bot commented Sep 17, 2024

Coverage

Coverage Report (54749d5, 3.12, macos-latest)
FileStmtsMissCoverMissing
hamilflow
   __init__.py00100% 
hamilflow/maths
   __init__.py20100% 
   trigonometrics.py1322 85%
hamilflow/models
   __init__.py00100% 
   brownian_motion.py4922 96%
   free_particle.py3822 95%
   harmonic_oscillator.py1151010 91%
   harmonic_oscillator_chain.py4677 85%
   pendulum.py6022 97%
hamilflow/models/kepler_problem
   __init__.py20100% 
   dynamics.py6122 97%
   model.py1271111 91%
   numerics.py591111 81%
hamilflow/models/utils
   __init__.py00100% 
   typing.py40100% 
TOTAL5764991% 

Tests Skipped Failures Errors Time
2642 22 💤 0 ❌ 0 🔥 9.939s ⏱️

Copy link
Contributor

github-actions bot commented Sep 17, 2024

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-09-25 06:59 UTC

@emptymalei emptymalei marked this pull request as ready for review September 22, 2024 10:58
Copy link
Collaborator

@cmp0xff cmp0xff left a comment

Choose a reason for hiding this comment

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

The tutorial shows the trajectory, which is solved by the textbook Kepler problem. However, it does not show our strength in that the trajectory is parameterised by time. For example, can we use colour to indicate the speed?

docs/tutorials/kepler_problem.py Outdated Show resolved Hide resolved
docs/tutorials/kepler_problem.py Outdated Show resolved Hide resolved
@cmp0xff cmp0xff changed the title Add tutorial for Kepler2D doc(Kepler): #82 add tutorial Sep 23, 2024
@emptymalei
Copy link
Member Author

The tutorial shows the trajectory, which is solved by the textbook Kepler problem. However, it does not show our strength in that the trajectory is parameterised by time. For example, can we use colour to indicate the speed?

good point. I added some animations.

@cmp0xff cmp0xff changed the title doc(Kepler): #82 add tutorial doc(kepler-problem): #82 add tutorial Sep 23, 2024
Copy link
Collaborator

@cmp0xff cmp0xff left a comment

Choose a reason for hiding this comment

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

The tutorial shows the basics and our strengths. I can approve it after this round of review.

  • We need to fix the floating error when displaying t. Currently we see weird numbers like -3.299999999, -3.199999999, -3.1, etc. If I were writing the code, I would divide 1 by a power of 2.
  • We can to make the animations more impressive.
    • We need to make them smoother.
    • For periodic orbits, we can do fewer revolutions.
    • For unbounded motion, we should somehow emphasise that the motion near the vertex is faster.

docs/tutorials/kepler_problem.py Outdated Show resolved Hide resolved
@emptymalei emptymalei merged commit ff67b48 into main Sep 25, 2024
8 checks passed
@emptymalei emptymalei deleted the feature/lm/kepler-tutorial branch September 25, 2024 06:58
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
None yet
Development

Successfully merging this pull request may close these issues.

Finish tutorial of Kepler Problem
2 participants