Repository navigation
Conversation
Signed-off-by: Nick Murphy <namurphy@cfa.harvard.edu>
Signed-off-by: Nick Murphy <namurphy@cfa.harvard.edu>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3193 +/- ##
==========================================
+ Coverage 94.59% 95.36% +0.77%
==========================================
Files 108 110 +2
Lines 9872 9879 +7
Branches 1501 1501
==========================================
+ Hits 9338 9421 +83
+ Misses 332 262 -70
+ Partials 202 196 -6 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Signed-off-by: Nick Murphy <namurphy@cfa.harvard.edu>
Signed-off-by: Nick Murphy <namurphy@cfa.harvard.edu>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Important
Before this pull request can be merged, we would need to update PLEP 7 to include
plasmapy.distribution(PlasmaPy/PlasmaPy-PLEPs#53).Description
This is a prototype pull request to create the
plasmapy.distributionsubpackage to include particle distribution functions, starting with the Maxwellian (or Maxwell-Boltzmann) distribution.This is included in §4.3 of the NSF CSSI proposal that we recently submitted.
Motivation
PlasmaPy currently has functions for particle distribution functions in
plasmapy.formulary.distribution, including Maxwellians and kappa distributions for 1D, 2D, and 3D. However, each individual function accepts ∼5 arguments. If one wanted to calculate multiple properties of one of these distribution functions, they would have to provide all of the arguments every time that they calculate something new, unless they simplified it withfunctools.partial.My goal is to create classes to represent different particle distribution functions. The API would be something like...
There's more than enough functionality related to particle distribution functions to create a new subpackage. In particular, we'll eventually need functionality for discretized particle distribution functions, which are important for space plasma, and hence interoperability with the Python in Heliophysics Community.