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

Deprecate our magnetostatics functionality? #1688

Open
2 tasks
StanczakDominik opened this issue Aug 23, 2022 · 1 comment
Open
2 tasks

Deprecate our magnetostatics functionality? #1688

StanczakDominik opened this issue Aug 23, 2022 · 1 comment
Labels
breaking change For breaking changes, excluding deprecations and planned removals proposal Proposals that need to be decided upon before implementation

Comments

@StanczakDominik
Copy link
Member

Last telecon, myself, @rocco8773 and @namurphy discussed that our magnetostatics functionality, while okay-ish, is essentially a subset of functionality contained in MagpyLib. We'd like to trim some of the less-used and less maintained functionality the package , so that one seems like a prime candidate.

Things to consider:

  • IIRC, MagpyLib gives outputs in mT. One thing we considered during the telecon was to monkeypatch/provide shims on top of their functionality that makes stuff return astropy Quantities.
  • should we wire the existing magnetostatics functionality to stuff in MagpyLib, or just deprecate it and tell users to use MagpyLib directly instead?
@StanczakDominik StanczakDominik added proposal Proposals that need to be decided upon before implementation Breaking labels Aug 23, 2022
@pheuer
Copy link
Member

pheuer commented Aug 26, 2022

I agree - MagpyLib is quite good and being actively maintained (last release was only a couple weeks ago). I think it makes sense to make any contributions we want directly to MagpyLib rather than having our own version of essentially the same thing.

I vote that the magnetostatics notebook remain and be reworked in to an example using MagpyLib and the Plasmapy Plasma class/CartesianGrid to show how to use MagpyLib with PlasmaPy. If that can be done easily enough, then the magnetosonics module is clearly superfluous.

@github-actions github-actions bot added the Stale Dormant issues & PRs which will be automatically closed if the label is not removed. label Oct 26, 2022
@namurphy namurphy removed the Stale Dormant issues & PRs which will be automatically closed if the label is not removed. label May 12, 2023
@namurphy namurphy added breaking change For breaking changes, excluding deprecations and planned removals and removed breaking labels May 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change For breaking changes, excluding deprecations and planned removals proposal Proposals that need to be decided upon before implementation
Projects
None yet
Development

No branches or pull requests

3 participants