The SunPy 1.0 paper repository.
The paper was published in ApJ on 2020 February 12 and can be found here.
How to cite this is found here.
Alongside this paper we submitted to JOSS.
The purpose of this paper is to describe the upcoming v1.0 release of SunPy, describe the project, its aims and goals and the infrastructure. It is not meant to replace or repeat the documentation.
This paper will be submitted to the software software of the Astrophysical Journal.
Please follow the following standards. We designed the following guidelines to make the paper easily digestible and accessible for everyone.
- Use the defined commands in
main.tex. - Do not include code examples.
- Use the first-person plural ("we") and the active voice. E.g.:
- active: "the diversity of data sets makes this difficult"
- passive: "this is made difficult by the diversity of data sets"
- active: "The SunPy Community et al. (2015) described version 0.5"
- passive: "Version 0.5 was described in The SunPy Community et al. (2015)"
- Avoid overly technical language (like subclass, decorator, namespace, mixin, and factory) wherever possible.
- Use plain English to reference a piece of code (e.g. "a Pandas dataframe" versus "a
pandas.DataFrame"). - Define references to other code whenever reasonable (e.g. "a Pandas dataframe, or a two-dimensional data structure aligned in rows and columns").
Please always be strict on having one sentence per line to aid in git diffing and latex error detection.
Please provide feedback or comments as issues. There is also a Riot channel devoted to organizing and discussing this paper.
This paper will have an inclusive authorship policy, modeled after the authorship policy of the yt 3.0 paper.
1] Anyone with an official role with the SunPy project as well as anyone that has contributed code to the sunpy package is guaranteed authorship (as long as they agree).
2] If you feel your contribution to the SunPy community, code, or ecosystem is enough to warrant authorship, please click the following to create an issue and follow the template Gituhub issue. We only ask that you provide a short description describing your contribution. We will not evaluate these short descriptions in any way -- we will simply aggregate them.
The timeline for this paper is
- April 1st - First draft
- May 1st - Second draft
- June 1st - Third draft (good enough to be handed out at SPD meeting in Jun)
- July 1st - Fourth draft final review
- Aug 23 - Submitted to ApJ
In order coordinate editing the paper and submitting pull requests please send a message to the Riot channel to let people know you are working on a particular section.
