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

Add example notebook for MHD wave dispersion relations #2198

Open
namurphy opened this issue Jun 6, 2023 · 3 comments · May be fixed by #2460
Open

Add example notebook for MHD wave dispersion relations #2198

namurphy opened this issue Jun 6, 2023 · 3 comments · May be fixed by #2460
Labels
notebooks Related to example Jupyter notebooks in docs/examples/ Plasma Lv3 | Proficient Issues that require proficiency in plasma physics plasmapy.dispersion Related to the plasmapy.dispersion subpackage Python Lv2 | Intermediate Issues that require a medium amount of knowledge of Python
Milestone

Comments

@namurphy
Copy link
Member

namurphy commented Jun 6, 2023

Following up on #2197, it would be really helpful to include an example notebook that covers the three different types of MHD waves. The notebook should give an understandable introduction to Alfvén, fast magnetosonic, and slow magnetosonic waves. It would be helpful to include the formulae for the dispersion relations, and talk about what is physically happening in each of the waves. Diagrams indicating the nature of each of the waves would be helpful too.

I keep meaning to do this every year, but it would be really helpful to have this in place by the SULI summer course in June 2024.

@namurphy namurphy added this to the 2024.5.0 milestone Jun 6, 2023
@namurphy namurphy added plasmapy.dispersion Related to the plasmapy.dispersion subpackage Python Lv2 | Intermediate Issues that require a medium amount of knowledge of Python Plasma Lv3 | Proficient Issues that require proficiency in plasma physics notebooks Related to example Jupyter notebooks in docs/examples/ labels Jun 6, 2023
@TrestanSimon
Copy link
Contributor

Hi @namurphy. Now that #2206 has merged, I am interested in working on this if that is alright. Before I begin, I have two quick questions:

  1. Do you think a brief derivation of the dispersion relations should be worked into the notebook? (Maybe something like this)
  2. Do you think the "diagrams indicating the nature of each of the waves" should be generated with PlasmaPy/Python or embedded from elsewhere (something like this)?

@namurphy
Copy link
Member Author

namurphy commented Oct 24, 2023

Now that #2206 has merged, I am interested in working on this if that is alright.

That would be fantastic! In case you'll be at the APS DPP meeting next week, we'll have a table there if you'd like to stop by.

Do you think a brief derivation of the dispersion relations should be worked into the notebook? (Maybe something like this)

I think a brief derivation would be helpful. An alternative place would be the docstrings of the classes or module. We wouldn't be able to directly use the Wikipedia text since it is under the copyleft CC-BY-SA license and PlasmaPy is under the permissive BSD 3-clause license, but we could add something similar.

Do you think the "diagrams indicating the nature of each of the waves" should be generated with PlasmaPy/Python or embedded from elsewhere (something like this)?

I think it'd be fine to use a graphic from elsewhere, and I like the one you pointed to. I almost mentioned license compatibility here too, but it looks like you're the one who created that figure which is awesome!

Thank you again!

@TrestanSimon
Copy link
Contributor

That would be fantastic! In case you'll be at the APS DPP meeting next week, we'll have a table there if you'd like to stop by.

I will definitely stop by!

I think a brief derivation would be helpful. An alternative place would be the docstrings of the classes or module. We wouldn't be able to directly use the Wikipedia text since it is under the copyleft CC-BY-SA license and PlasmaPy is under the permissive BSD 3-clause license, but we could add something similar.

I think since the derivations of all three DRs are identical, it would be best to add a single derivation to the module docstring if not in the notebook. And I just mean something with similar brevity as the Wikipedia derivation. Although, since I contributed this text to the article, I retain the copyright and can re license if necessary (if my understanding of this is correct).

I think it'd be fine to use a graphic from elsewhere, and I like the one you pointed to. I almost mentioned license compatibility here too, but it looks like you're the one who created that figure which is awesome!

Thanks. I also just mean something similar. I am unaware of relevant diagrams with compatible licenses, so I just linked my own.

@TrestanSimon TrestanSimon linked a pull request Jan 12, 2024 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
notebooks Related to example Jupyter notebooks in docs/examples/ Plasma Lv3 | Proficient Issues that require proficiency in plasma physics plasmapy.dispersion Related to the plasmapy.dispersion subpackage Python Lv2 | Intermediate Issues that require a medium amount of knowledge of Python
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants