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 addition of the Collisional Analysis notebook #2191

Open
wants to merge 54 commits into
base: main
Choose a base branch
from

Conversation

ejohnson-96
Copy link
Contributor

Description

Adds a notebook to walk the user through the collisional analysis functionality.

Motivation and context

Related issues

@ejohnson-96 ejohnson-96 requested a review from a team as a code owner June 1, 2023 19:51
@ejohnson-96 ejohnson-96 requested review from namurphy and removed request for a team June 1, 2023 19:51
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions
Copy link

github-actions bot commented Jun 1, 2023

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:

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!

@github-actions github-actions bot added docs PlasmaPy Docs at http://docs.plasmapy.org notebooks Related to example Jupyter notebooks in docs/examples/ labels Jun 1, 2023
@codecov
Copy link

codecov bot commented Jun 1, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (0c6c2d6) 98.37% compared to head (54e26c3) 98.37%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2191   +/-   ##
=======================================
  Coverage   98.37%   98.37%           
=======================================
  Files          98       98           
  Lines        8531     8531           
=======================================
  Hits         8392     8392           
  Misses        139      139           

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

@ejohnson-96 ejohnson-96 reopened this Jul 26, 2023
@github-actions github-actions bot removed the plasmapy.formulary Related to the plasmapy.formulary subpackage label Jul 26, 2023
ejohnson-96 and others added 2 commits July 27, 2023 15:30
Co-authored-by: Nick Murphy <namurphy@cfa.harvard.edu>
@ejohnson-96
Copy link
Contributor Author

yay

@ejohnson-96 ejohnson-96 changed the title CoAl notebook Doc addition of the Collisional Analysis notebook Jul 31, 2023
ejohnson-96 and others added 5 commits July 31, 2023 15:31
Co-authored-by: Nick Murphy <namurphy@cfa.harvard.edu>
Co-authored-by: Nick Murphy <namurphy@cfa.harvard.edu>
Co-authored-by: Nick Murphy <namurphy@cfa.harvard.edu>
@@ -0,0 +1,513 @@
{
Copy link
Member

@namurphy namurphy Jul 31, 2023

Choose a reason for hiding this comment

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

Could you make sure that there are spaces between each of cm^3 km K^{3/2}?


Reply via ReviewNB

"$$\n",
"\n",
"\n",
"In these equations, $C_{1} = 2.60 \\times 10^{7} \\, {\\rm cm}^{3} \\, {\\rm km} \\, {\\rm K}^{3/2} \\, {\\rm s}^{-1} \\, {\\rm au}^{-1}$, $C_{2} = 1 \\, {\\rm cm}^{-3/2}{\\rm K}^{-3/2} $, $Z_\\alpha \\equiv q_\\alpha/q_{\\rm p} = 2$ is the $\\alpha$-proton relative charge, $\\mu_\\alpha \\equiv m_\\alpha/m_{\\rm p} \\approx 4$ is their relative mass, and $\\eta_{\\alpha{\\rm p}} \\equiv n_\\alpha/n_{\\rm p}$ is the their relative abundance.\n",
Copy link
Member

@namurphy namurphy Jul 31, 2023

Choose a reason for hiding this comment

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

Suggested change
"In these equations, $C_{1} = 2.60 \\times 10^{7} \\, {\\rm cm}^{3} \\, {\\rm km} \\, {\\rm K}^{3/2} \\, {\\rm s}^{-1} \\, {\\rm au}^{-1}$, $C_{2} = 1 \\, {\\rm cm}^{-3/2}{\\rm K}^{-3/2} $, $Z_\\alpha \\equiv q_\\alpha/q_{\\rm p} = 2$ is the $\\alpha$-proton relative charge, $\\mu_\\alpha \\equiv m_\\alpha/m_{\\rm p} \\approx 4$ is their relative mass, and $\\eta_{\\alpha{\\rm p}} \\equiv n_\\alpha/n_{\\rm p}$ is the their relative abundance.\n",
"In these equations, $C_{1} = 2.60 \\times 10^{7}$ cm$^3$ km K$^{3/2}$ s$^{-1}$ au$^{-1}$, $C_{2} = 1 \\, {\\rm cm}^{-3/2}{\\rm K}^{-3/2} $, $Z_\\alpha \\equiv q_\\alpha/q_{\\rm p} = 2$ is the $\\alpha$-proton relative charge, $\\mu_\\alpha \\equiv m_\\alpha/m_{\\rm p} \\approx 4$ is their relative mass, and $\\eta_{\\alpha{\\rm p}} \\equiv n_\\alpha/n_{\\rm p}$ is the their relative abundance.\n",

@namurphy namurphy modified the milestones: 2023.10.0, v2024.1.0 Oct 22, 2023
@namurphy namurphy removed this from the v2024.1.0 milestone Jan 17, 2024
@namurphy namurphy added this to the Future milestone Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org notebooks Related to example Jupyter notebooks in docs/examples/ packaging Related to packaging or distribution requirements Related to updating requirements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants