Add example notebook for MHD wave dispersion relations

[TrestanSimon]

Description

As discussed in #2198, this PR adds an example notebook for the MHD dispersion module (mhd_waves_) that aims to introduce the three linear, ideal MHD waves while demonstrating the module's functionality.

Motivation and context

Explained in detail in #2198. Should be complete before June.

Related issues

Closes #2198

To do

• Introduce/explain Alfvén waves
• Introduce/explain fast and slow magnetosonic waves
• Graph phase and group velocities
• Create and add diagrams

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[github-actions]

Thank you for submitting a pull request (PR) to PlasmaPy! ✨ The future of the project depends on contributors like you, so we deeply appreciate it! 🌱

Our contributor guide has information on:

• Getting ready to contribute and the code contribution workflow
• Using astropy.units and plasmapy.particles
• Coding tips and guidelines
• Writing documentation (in reStructuredText with numpydoc style docstrings).
• Writing tests using pytest
• Adding a changelog entry (needed except for minor changes)

The bottom of this page shows several checks that are run for every PR. Don't worry if something broke! We break stuff all the time. 😺 Click on "Details" to learn why a check didn't pass. Please also feel free to ask for help. We do that all the time as well. 🌸 You can find us in our chat room or weekly community meeting & office hours. Here are some tips:

• Try fixing CI / Python 3.11 test failures first.
• Most pre-commit.ci - pr failures can be automagically fixed by commenting pre-commit.ci autofix below, followed by a git pull to bring the changes back to your computer.
• If pre-commit.ci - pr says that a function is too long or complex, try breaking up that function into multiple short functions that each do one thing. See also these tips on writing clean scientific software.
• If the CI / Documentation check ends with a cryptic error message, check out our documentation troubleshooting guide.
• For a documentation preview, click on Details next to docs/readthedocs.org:plasmapy.

If this PR is marked as ready for review, someone should stop by to provide a code review and offer suggestions soon. ✅ If you don't get a review within a few days, please feel free to send us a reminder.

Please also use SI units within PlasmaPy, except when there is strong justification otherwise or in some examples.

We thank you once again!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.93%. Comparing base (40e94e4) to head (a252af3).

❗ Current head a252af3 differs from pull request most recent head eeab346. Consider uploading reports for the commit eeab346 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2460      +/-   ##
==========================================
+ Coverage   95.17%   96.93%   +1.75%     
==========================================
  Files         104      104              
  Lines        9417     9165     -252     
  Branches     2154        0    -2154     
==========================================
- Hits         8963     8884      -79     
- Misses        276      281       +5     
+ Partials      178        0     -178     

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

[TrestanSimon]

Hi all. I have not forgotten about this PR. It should be ready for review within the next few days.

Edit (25-05-2024): This may take a little longer than I expected, unfortunately.