SunPy Affiliated Packages

What is an affiliated package?

Affiliated packages are well-maintained, open source software packages that are useful to solar physicists and integrate well with the SunPy ecosystem. To aid discoverability, all affiliated packages are listed on the SunPy website, and the SunPy project tries to advertise them at national and international conferences and workshops.

Affiliated Packages

aiapy

aiapy is a Python package for analyzing data from the Atmospheric Imaging Assembly (AIA) instrument onboard NASA’s Solar Dynamics Observatory spacecraft.

Links

Maintainer(s)

Review

Version Reviewed

Docs, Code

Will Barnes, Mark Cheung

package_specialized integration_full docs_extensive tests_good duplication_none community_good dev_stc

v0.1.0

pfsspy

A python Potential Field Source Surface model package.

Links

Maintainer(s)

Review

Version Reviewed

Docs, Code

David Stansby

package_specialized integration_full docs_extensive tests_excellent duplication_none community_excellent dev_stc

v0.5.2

Provisional Affiliated Packages

pyflct

A Python wrapper for Fourier Local Correlation Tracking.

Links

Maintainer(s)

Review

Version Reviewed

Docs, Code

Nabil Freij, Stuart Mumford

package_specialized integration_none docs_some tests_excellent duplication_none community_good dev_low

v0.2.1

radiospectra

This package provides support for some types of solar radio spectragrams (e.g. CALISTO, SWAVES).

Links

Maintainer(s)

Review

Version Reviewed

Docs, Code

David Pérez-Suárez

package_general integration_none docs_some tests_good duplication_some community_excellent dev_stc

master

Affiliated Package Review

Each candidate package is reviewed by a reviewer independent of the package before it can be approved as an affiliated package.

Review Criteria

Functionality

Status

Meaning

general

Implements functionality relevant to a large cross-section of the solar physics community.

specialized

Implements functionality which is relevant to a specific subsection of the solar physics community.

notrelevant

This package does not implement functionality relevant to the solar physics community.

Integration

Status

Meaning

full

The package uses all appropriate features of the core package and affiliated package ecosystem to provide its functionality to users. It uses applicable data structures and has appropriate dependencies.

incomplete

Some applicable functionality of the affiliated package ecosystem may be used but further integration is possible in this package.

no

Provides functionality which should use features such as data structures in core or other affiliated packages. i.e. provides an array and a WCS but doesn’t use ndcube, or represents physical coordinates not using sunpy.coordinates.

Documentation

Status

Meaning

extensive

Extensive online documentation, the public API has formatted docstrings describing the code’s purpose, all inputs and outputs, and includes examples. Provides high level documentation; for example, a user guide and/or an example gallery.

good

Online documentation is either lacking in coverage or quality. For example some docstrings maybe lacking detail, or examples, or there may be minimal high level documentation.

some

Some online documentation. The public API is documented, but may have some missing or incomplete docstrings. The documentation may be missing guides, tutorials or other high level documentation.

little

Little to no online documentation is provided in the version control repository. No guides or tutorials.

Testing

Status

Meaning

excellent

A high quality testing suite exists which tests the individual components (e.g. functions, classes) as well as providing integration tests. Code coverage is extensive. Testing is automated and runs frequently.

good

Unit tests of individual components (e.g. functions, classes) and integration tests, but coverage is good but not extensive. Testing is automated.

needs_work

Lacks tests and/or tests are not executed in a test framework (e.g. pytest).

Duplication

Status

Meaning

none

No code or functionality is duplicated from core, other affiliated packages, or other relevant packages.

some

Some code or functionality duplication, some minor functionality may be duplicated from other affiliated packages, or other relevant packages.

major

Duplicates major existing functionality in other affiliated packages.

Community

Status

Meaning

excellent

The developers actively solicit input to aid their decision-making, gather and react to community feedback, and work with other developers to improve ecosystem integration. The developers are active and engaged with the community. The package must also meet the requirements for a ‘Good’ rating.

good

The package is developed openly. The developers have adopted a Code of Conduct compatible with SunPy’s. The developers have adopted a Code of Conduct that reflects and is not contradictory to the values in the SunPy Code of Conduct. They welcome contributions, maintain and respond to an issue tracker, and are receptive to appropriate community feedback.

needs_work

Code is maintained in hosted version control, but decisions are often made without considering community input or feedback. Lacks a Code of Conduct. It is not clear how to make a contribution or whether contributions are welcome. Developers do not respond to issues or an issue tracker is not used.

Development Status

Status

Meaning

stable

Package is well maintained, contributions are responded to by the developers. API stability is prioritised and regular versioned releases are made, with any breaking changes well documented.

stc_dev

Package is well maintained, but large API changes may be frequent due to rapid development. Contributions are responded to by the developers. Versioned releases exist and changes are documented.

low_activity

Package is functional but with little or no activity from the developers. The package has versioned releases and is functional.

needs_work

Package is no longer maintained and is not functional.

Review Criteria and Summary

Outcomes

Requirements

Accepted

Must have a green score in the Functionality criteria and at least one other. They must also have no red scores.

Provisional

After review a package is listed as provisional, as long as it is assessed to not have a red score in the “Functionality”, “Duplication” or “Community” criteria and is working towards meeting the rest of the review criteria.

Not accepted

A package does not currently satisfy the provisional rating.

Open review process

The review process for becoming a SunPy affiliated package is designed to be approachable, lightweight and open. Reviews are conducted in GitHub issues through the https://github.com/sunpy/sunpy.org repository.

Steps for Getting New Packages Reviewed

  1. If you’re not sure whether to submit your package for the affiliated package review process, you can open an issue to informally discuss your package or contact the Affiliated Package Liaison to discuss your package privately.

  2. Open a new issue with the issue template.

  3. The Affiliated Package Liaison will identify a reviewer independent of your package.

  4. The reviewer evaluates the affiliated package against the review criteria.

  5. The reviewer adds their review as a comment to the issue.

  6. The submitting author has the right to ask for another review. In this case, the Affiliated Package Liaison will identify a new independent reviewer. This new review will be added to the same issue.

  7. Based on the scores in each of the seven categories, the affiliated package is either accepted, given provisional status, or not accepted. In all three cases, this practically means closing the issue and ending the review process. In the last case, the reviewer provides the submitting author with feedback on how to meet the acceptance criteria with the intention of helping the submitting author achieve provisional or accepted status in the future.

  8. If the review passed the review criteria then the submitting author or the Affiliated Package Liaison opens a pull request to add the package and its review results to the sunpy.org website, unless the submitting author withdraws the submission.

  9. The Affiliated Package Liaison merges the pull request.

Existing Packages Review Process

Existing affiliated packages will be reviewed once per year by the Affiliated Package Liaison to ensure the review is current. Developers may challenge a new review, which then requires the liaison to get an independent reviewer to perform the review.

Existing provisional affiliated packages will be reviewed once per year by the Affiliated Package Liaison. To pass they must not have a worse score and still be working towards meeting the rest of the review criteria.

Acknowledgements

Sections of this page are heavily inspired by the Astropy affiliated package review process.