Submit pfsspy to be an affliated package

dstansby commented 4 years ago

Package Details

Package name: pfsspy
Maintainer(s): David Stansby
Repository: https://github.com/dstansby/pfsspy
PyPI link (if applicable): https://pypi.org/project/pfsspy/

Description of Package

A python Potential Field Source Surface model package.

Package Review

Editor Submission Checklist

[x] Is the submission appropriate (compatible with the SunPy CoC)?
[x] Does the project have an appropriate license?
[x] Is the project in a version control repository?
[x] Does the project provide a Python interface?
[x] Is the project on PyPI?
[x] Is the project useful to the solar physics community?

Instructions to Reviewer

Please copy the following and select the ranking for each criteria, the full review criteria can be found here:

* Functionality           : General Package / Specialized Package / Not Relevant
* Integration             : Well integrated / Partially Integrated / Minimal Integration
* Documentation           : Extensive / Some / Little
* Testing                 : Excellent / Good / Needs Work
* Duplication             : None / Some / Major
* Community               : Excellent / Good / Needs Work
* Development Status      : Stable / Rapid Development / Low Activity / Needs Work

Cadair commented 4 years ago

@wtbarnes Could you review this one? :grin:

wtbarnes commented 4 years ago

Functionality: Specialized Package This package is useful to anyone who wants to do magnetic modeling using a potential field source surface model, a very common technique in solar physics. I say this is a specialized package not because it appeals to only a few in the community, but because the scope is relatively narrow.

Integration: Well integrated The package uses both SkyCoord for describing field line traces as well as sunpy.map.Maps for representing two-dimensional magnetic field maps that provide the lower boundary condition.
Documentation: Extensive The documentation is linked on the repository, resides on Read the Docs, and includes both extensive API documentation as well as several examples
Testing: Excellent Coverage is reported from coveralls at 94%. The package is tested on Python 3.6-3.8 automatically on Travis CI. The package is also tested against development versions of sunpy and astropy to anticipate breaking changes.
Duplication: None pfsspy does not duplicate any functionality in the core package. While it does have overlap in scope with the solarbextrapolation package, that package is largely unmaintained so any duplication there is irrelevant.
Community: Excellent Though pfsspy only has a single contributor, the author is closely engaged with the community, is a core SunPy contributor, and regularly seeks feedback on various components of the package from the community.
Development Status: Subject to Change The package is on v0.5.1, pre-1.0, so breaking API changes are reasonable to expect.

Cadair commented 4 years ago

that package is largely unmaintained

for the record, solarbextrapolation has been shutdown and archived. It is dead Dave.

wtbarnes commented 4 years ago

that package is largely unmaintained

for the record, solarbextrapolation has been shutdown and archived. It is dead Dave.

Ha very true. I think I meant to write something more like archived. My sleepy brain disagreed

wtbarnes commented 4 years ago

It looks like pfsspy does not have a code of conduct which is a requirement for the community section. Did I just miss this @dstansby?

Cadair commented 4 years ago

There is this section in the readme: https://github.com/dstansby/pfsspy#code-of-conduct which references the sunpy one. Might be good for @dstansby to add it to the docs as well, but it's enough I think?

dstansby commented 4 years ago

Yes, I added that yesterday so it may have been just before your review or not obvious. I will add it to the docs in time for the next stable release.

wtbarnes commented 4 years ago

Yep, I'm totally ok with that 👍

sunpy / sunpy.org