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

Decorate ion_sound_speed with @particle_input #2134

Merged
merged 3 commits into from May 15, 2023

Conversation

namurphy
Copy link
Member

This PR decorates the plasmapy.formulary.speeds.ion_sound_speed with @particle_input in order to enhance compatibility with ParticleList and CustomParticle objects. The z_mean parameter for ion_sound_speed has been deprecated.

@github-actions
Copy link

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.

  • Try fixing CI/Python 3.11 test failures first.
  • Most pre-commit.ci failures can be automagically fixed by commenting "pre-commit.ci autofix" below, followed by a git pull.
  • In the CI/Documentation 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 soon to provide a code review and offer suggestions soon. ✅ If you don't get a review within a few weekdays, please feel free to send us a reminder.

Please also use SI units within PlasmaPy, except when there is strong justification otherwise (e.g., in some examples).

We thank you once again!

@github-actions github-actions bot added plasmapy.formulary Related to the plasmapy.formulary subpackage testing labels May 12, 2023
@github-actions github-actions bot added the plasmapy.dispersion Related to the plasmapy.dispersion subpackage label May 12, 2023
@codecov
Copy link

codecov bot commented May 12, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: -0.01 ⚠️

Comparison is base (aff21ae) 98.38% compared to head (652d53e) 98.38%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2134      +/-   ##
==========================================
- Coverage   98.38%   98.38%   -0.01%     
==========================================
  Files          98       98              
  Lines        8625     8624       -1     
==========================================
- Hits         8486     8485       -1     
  Misses        139      139              
Impacted Files Coverage Δ
plasmapy/dispersion/analytical/two_fluid_.py 100.00% <ø> (ø)
plasmapy/dispersion/numerical/hollweg_.py 100.00% <ø> (ø)
plasmapy/dispersion/numerical/kinetic_alfven_.py 100.00% <ø> (ø)
plasmapy/formulary/speeds.py 97.77% <100.00%> (-0.03%) ⬇️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@namurphy namurphy marked this pull request as ready for review May 12, 2023 19:27
@namurphy namurphy requested review from ejohnson-96 and a team as code owners May 12, 2023 19:27
@namurphy namurphy added the PDD label May 13, 2023
@namurphy namurphy changed the title Decorate ion_sound_speed with @particle_input` Decorate ion_sound_speed with @particle_input May 13, 2023
@namurphy namurphy removed the request for review from a team May 13, 2023 04:01
Copy link
Contributor

@ejohnson-96 ejohnson-96 left a comment

Choose a reason for hiding this comment

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

👍

@ejohnson-96 ejohnson-96 merged commit 7aab89a into PlasmaPy:main May 15, 2023
13 checks passed
@namurphy namurphy deleted the particle-input-ion_sound_speed branch May 24, 2023 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
plasmapy.dispersion Related to the plasmapy.dispersion subpackage plasmapy.formulary Related to the plasmapy.formulary subpackage testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants