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

BRL Langmuir Probe Theory #2344

Draft
wants to merge 86 commits into
base: main
Choose a base branch
from
Draft

BRL Langmuir Probe Theory #2344

wants to merge 86 commits into from

Conversation

kuchtact
Copy link

Description

This pull request implements the BRL (Bernstein-Rabinowitz-Laframboise) Langmuir probe theory.

Motivation and context

The BRL theory is useful for analyzing Langmuir probes in certain regimes. Additionally, all the papers to my knowledge that reference BRL only use the numbers published by Laframboise in his unpublished thesis so this will also create open source code for recreating those values.

Related issues

This pull request will close #445.

@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. 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 the plasmapy.diagnostics Related to the plasmapy.diagnostics subpackage label Sep 21, 2023
@codecov
Copy link

codecov bot commented Sep 21, 2023

Codecov Report

Attention: Patch coverage is 58.49057% with 44 lines in your changes are missing coverage. Please review.

Project coverage is 97.78%. Comparing base (534b8e9) to head (6489a6b).

Current head 6489a6b differs from pull request most recent head 3da9646

Please upload reports for the commit 3da9646 to get more accurate results.

Files Patch % Lines
...py/diagnostics/brl/poisson_equation_integration.py 19.35% 25 Missing ⚠️
plasmapy/diagnostics/brl/charge_density.py 28.57% 15 Missing ⚠️
plasmapy/diagnostics/brl/net_spacing.py 92.10% 3 Missing ⚠️
plasmapy/diagnostics/brl/integration.py 93.75% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2344      +/-   ##
==========================================
+ Coverage   95.25%   97.78%   +2.53%     
==========================================
  Files         104      106       +2     
  Lines        9435     8712     -723     
  Branches     2159        0    -2159     
==========================================
- Hits         8987     8519     -468     
+ Misses        272      193      -79     
+ Partials      176        0     -176     

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

This function replicates the equations in appendix D of Laframboise's
thesis, namely D.21 and D.22.
@github-actions github-actions bot added the packaging Related to packaging or distribution label Sep 25, 2023
@github-actions github-actions bot added the python Pull requests that update Python code label May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
packaging Related to packaging or distribution plasmapy.diagnostics Related to the plasmapy.diagnostics subpackage python Pull requests that update Python code testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add BRL Langmuir probe theory
2 participants