Skip to content

Submit SunPy to the Journal of Open Source Software#3391

Merged
Cadair merged 2 commits intomasterfrom
joss_paper
Feb 7, 2020
Merged

Submit SunPy to the Journal of Open Source Software#3391
Cadair merged 2 commits intomasterfrom
joss_paper

Conversation

@Cadair
Copy link
Copy Markdown
Member

@Cadair Cadair commented Oct 3, 2019

To accompany the submission of the SunPy 1.0 paper we are submitting sunpy for review by JOSS.

This PR contains the paper source, as per the submission requirements. It has to be included in one release version of SunPy (as indexed by Zenodo).

ToDo:

  • Deal with authorship 🙈
  • Submit

Review in progress: openjournals/joss-reviews#1832

THIS PR MUST BE SQUASH MERGED

See this comment for details on adding your author info.

@pep8speaks
Copy link
Copy Markdown

pep8speaks commented Oct 3, 2019

Hello @Cadair! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 27:29: E231 missing whitespace after ','
Line 30:38: E231 missing whitespace after ','
Line 30:51: W605 invalid escape sequence '\m'
Line 30:59: W605 invalid escape sequence '\A'
Line 31:38: E231 missing whitespace after ','
Line 31:53: W605 invalid escape sequence '\m'
Line 31:61: W605 invalid escape sequence '\A'
Line 39:101: E501 line too long (121 > 100 characters)
Line 64:39: E251 unexpected spaces around keyword / parameter equals
Line 64:41: E251 unexpected spaces around keyword / parameter equals

Comment last updated at 2020-02-07 15:50:06 UTC

@ghost
Copy link
Copy Markdown

ghost commented Oct 3, 2019

Thanks for the pull request @Cadair! Everything looks great!

@Cadair Cadair added the No Changelog Entry Needed Skip all changelog checks. label Oct 3, 2019
@Cadair Cadair added this to the 1.0.4 milestone Oct 3, 2019
@Cadair
Copy link
Copy Markdown
Member Author

Cadair commented Oct 3, 2019

Alright everyone, the policy for JOSS is for the authorship of this paper to match the authorship of the repository. Therefore we are planning on including you unless you opt out. If you don't want to be an author please let us know.

I shall now ping everyone github thinks is a contributor to this repo!

@Cadair @nabobalis @ehsteve @segfaulthunter @khughitt @ayshih @DanRyanIrish @derdon @dpshelio @PritishC @vn-ki @aringlis @Punyaslok @bsipocz @gunner272 @SolarDrew @dstansby @rhewett @Alex-Ian-Hamilton @hayesla @kaichogami @mattearnshaw @nitinkgp23 @ankitkmr @prateekiiest @Akram9 @MSKirk @mdmueller @sudk1896 @haathi @yashkgp @CyclingNinja @abit2 @wtbarnes @Cubostar @m-charlton @samaloney @ndchorley @himanshukgp @s0nskar @yashrsharma44 @jmason86 @Naman9639 @Hypnus1803 @larrymanley @agneet42 @quintusdias @mbobra @souravghosh97 @Airmansmith97

@bsipocz
Copy link
Copy Markdown
Member

bsipocz commented Oct 3, 2019

hmm, interesting. Could it be that it actually only notified the first 50 people on the list?

@Cadair
Copy link
Copy Markdown
Member Author

Cadair commented Oct 3, 2019

yeah I just confirmed this.

@Cadair
Copy link
Copy Markdown
Member Author

Cadair commented Oct 3, 2019

@Cadair
Copy link
Copy Markdown
Member Author

Cadair commented Oct 3, 2019

and once more:
@martiansideofthemoon @kaustubhhiware @Pac23 @Mmendero @BoboTiG @olebole @rajasekharmekala @talsperre @jains8844 @ytann @tdwilkinson @tiagopereira @yudhik11 @jamescalixto

@Cadair
Copy link
Copy Markdown
Member Author

Cadair commented Oct 3, 2019

If you do want to be an author and you want to set your orcid and affiliations please leave an inline comment in the right place in the diff preferably as a suggestion (see step 6 here) so that someone doesn't have to go through them all 🤣

(I have now added all the names generated from git shortlog which isn't the same list as the people I just pinged.)

once you have added your details, you might want to unsubscribe from the issue by clicking the button on the right hand side at the top!!

Copy link
Copy Markdown

@mwcraig mwcraig left a comment

Choose a reason for hiding this comment

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

Minor comments on references for JOSS review at openjournals/joss-reviews#1832

@mwcraig
Copy link
Copy Markdown

mwcraig commented Nov 11, 2019

One other review comment -- considering adding language to address this JOSS review criteria:

State of the field: Do the authors describe how this software compares to other commonly-used packages?

xref openjournals/joss-reviews#1832

@Cadair
Copy link
Copy Markdown
Member Author

Cadair commented Nov 12, 2019

If anyone else wants to add author details please edit or leave a comment on metadata.yml.

@mbobra
Copy link
Copy Markdown
Member

mbobra commented Nov 12, 2019

One other review comment -- considering adding language to address this JOSS review criteria:

State of the field: Do the authors describe how this software compares to other commonly-used packages?

xref openjournals/joss-reviews#1832

@mwcraig We address this in the introduction section of the accompanying ApJ Paper. Does this satisfy the review criteria or would you like us to explicitly address this in the JOSS paper?

@mwcraig
Copy link
Copy Markdown

mwcraig commented Nov 13, 2019

@mwcraig We address this in the introduction section of the accompanying ApJ Paper. Does this satisfy the review criteria or would you like us to explicitly address this in the JOSS paper?

Fine question, have asked over on the JOSS issue.

@mwcraig
Copy link
Copy Markdown

mwcraig commented Nov 13, 2019

State of the field — adding a brief reference in the JOSS paper to the discussion in the ApJ is sufficient.

mbobra added a commit that referenced this pull request Nov 13, 2019
mbobra added a commit that referenced this pull request Nov 13, 2019
@nabobalis nabobalis modified the milestones: 1.0.6, 1.0.7 Nov 16, 2019
nabobalis pushed a commit that referenced this pull request Dec 20, 2019
nabobalis pushed a commit that referenced this pull request Dec 20, 2019
@nabobalis nabobalis modified the milestones: 1.0.7, 1.0.8 Jan 10, 2020
@Cadair Cadair requested a review from nabobalis February 7, 2020 12:28
Copy link
Copy Markdown
Member

@nabobalis nabobalis left a comment

Choose a reason for hiding this comment

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

It's good enough.

@Cadair Cadair merged commit fde97f3 into master Feb 7, 2020
@Cadair Cadair deleted the joss_paper branch February 7, 2020 16:22
Cadair added a commit that referenced this pull request Feb 13, 2020
* Write a JOSS paper

* Apply suggestions from code review

Co-Authored-By: Will Barnes <[email protected]>

Co-authored-by: Will Barnes <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

No Changelog Entry Needed Skip all changelog checks.

Projects

None yet

Development

Successfully merging this pull request may close these issues.