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

Amend PLEP 7 to include plasmapy.io #37

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

namurphy
Copy link
Member

It's likely that in the future we'll need a subpackage that contains input/output (I/O) functionality for open data formats commonly used in plasma science. This possible amendment to PLEP 7 would define plasmapy.io, which would be akin to astropy.io and sunpy.io. This would be the place to put the functionality for reading in and outputting files in the OpenPMD format, for example, which are currently in plasmapy.plasma.

@StanczakDominik
Copy link
Member

StanczakDominik commented Apr 21, 2021

The hdf5 case is a pretty good example!

Copy link
Member

@StanczakDominik StanczakDominik left a comment

Choose a reason for hiding this comment

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

I can't help but notice how we've been reverting (and with good reason!) package structure cleanups I did a while back. Non ironically, really happy to see that!

@namurphy namurphy marked this pull request as draft April 27, 2021 19:22
@namurphy
Copy link
Member Author

Converting it to a draft again for the moment to give it a bit more time to think about, in particular since I don't think we're going to implement this for a while.

@rocco8773 — did you want to mention your comments here?

@rocco8773
Copy link
Member

My comment: io feels like it should belong in plasmapy.utils instead of plasmapy. I view the top-level packages should be focused on plasma topics, except for utils and tests. Thus, io fits better with the plasmapy.utils package. Additionally, a goal of PLEP-7 is to manage the plasmapy namespace and adding io feels like a pollutant to that namespace.

With that said, I can still see some arguments for having io in the top-level namespace, especially if it's robust and defines metadata standards. However, that does feel like a soft argument to me. I'd like to see the scope and framework of io defined better and that could convince be to put io into the top-level namespace.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants