Skip to content

Initial draft of particle species class #1010

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Initial draft of particle species class #1010

wants to merge 3 commits into from

Conversation

StanczakDominik
Copy link
Member

Closes #1008

quick draft for now, using a dataclass; examples and docs still need to be added

  • I have added a changelog entry for this pull request.
  • If adding new functionality, I have added tests and
    docstrings.
  • I have fixed any newly failing tests.

@codecov
Copy link

codecov bot commented Feb 12, 2021 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.63%. Comparing base (6f163e0) to head (8899e65).
Report is 2041 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1010   +/-   ##
=======================================
  Coverage   96.62%   96.63%           
=======================================
  Files          64       65    +1     
  Lines        6249     6265   +16     
=======================================
+ Hits         6038     6054   +16     
  Misses        211      211

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@StanczakDominik
Copy link
Member Author

A few things to figure out:

  • how to document fields with a dataclass? Probably just like sphinx docs for variables but I still have to try it out
  • What other formulary functions should this support? For now I'm adding them as I need them for thesis, but...
  • In related questions: is there a clean-ish way to systematically, automatically add methods from the formulary that would take quantities Species have access to?
  • Ways to wrangle quantity_input into working with this? particle_input? Or skip for now?

namurphy
namurphy reviewed Feb 12, 2021
View reviewed changes
plasmapy/particles/species.py
from . import particle_class


@dataclass
Copy link
Member

Choose a reason for hiding this comment

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

Python 3.7! 😺 😺 😺 😺 😺

I think a dataclass is a good choice here, at the very least to start out with.

@namurphy namurphy added prototype 🏗️ Trying out an implementation on a trial basis plasmapy.particles Related to the plasmapy.particles subpackage status: dormant PRs that are stalled labels May 23, 2023
@namurphy namurphy added this to the Future milestone Apr 9, 2024
@github-actions GitHub Actions
Copy link

This pull request will be closed in 60 days due to a year of inactivity unless the stale label or comment is removed.

@github-actions github-actions bot added the Stale Dormant issues & PRs which will be automatically closed if the label is not removed. label Jul 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@namurphy namurphy namurphy left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
plasmapy.particles Related to the plasmapy.particles subpackage prototype 🏗️ Trying out an implementation on a trial basis Stale Dormant issues & PRs which will be automatically closed if the label is not removed. status: dormant PRs that are stalled
Projects
None yet
Milestone
Future
Development

Successfully merging this pull request may close these issues.

Create a class to represent an individual particle species
2 participants
@StanczakDominik @namurphy
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy