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.

Sign up for GitHub

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

Jump to bottom

ndcube Joss paper #599

Merged
merged 22 commits into from
Mar 9, 2023
Merged

ndcube Joss paper #599

merged 22 commits into from
Mar 9, 2023

Conversation

DanRyanIrish
Copy link
Member

PR Description

This PR writes a paper for submission to the Journal of Open Source Software.

DanRyanIrish and others added 14 commits November 11, 2021 09:27
@DanRyanIrish
First draft of JOSS paper.
534f064
@DanRyanIrish
Incorporate community use section of joss paper into summary section.
73e53ec
@DanRyanIrish
Condense data objects section of joss paper.
f600de9
@DanRyanIrish @Cadair
Apply suggestions from code review
addfa69 
Co-authored-by: Stuart Mumford <[email protected]>
@DanRyanIrish
Edits to JOSS paper draft based of comments from Stuart.
7123885
@DanRyanIrish
Merge branch 'main' of https://github.com/sunpy/ndcube into joss
f5374a6
@DanRyanIrish
Add figures for joss paper.
04a13b4
@DanRyanIrish
Add figures for joss paper.
cce8adb
@DanRyanIrish
Merge branch 'main' of https://github.com/sunpy/ndcube into joss
2641b9d
@DanRyanIrish
Simplify JOSS paper draft and add some co-authors.
545ea7b
@DanRyanIrish
Update references for joos paper.
81a27ba
@DanRyanIrish
Order JOSS paper co-authors by larger of additions/substractions.
bf921af
@DanRyanIrish
Minor bibtex changes to JOSS paper.
1b527af
@DanRyanIrish
Merge branch 'main' of https://github.com/sunpy/ndcube into joss
ba0eba6
@DanRyanIrish
Copy link
Member Author

@Cadair @yashrsharma44 @abit2 @adwaitbhope @nabobalis @hayesla @wtbarnes @BaptistePellorceAstro @rosteen @dhomeier @jmbhughes @ayshih @mwest007

Here is the latest draft of the ndcube JOSS paper which I will submit to be associated with our submission to ApJ. It justifies why ndcube is needed, summaries the package including its main data classes, and mentions ndcube's broader use. It is largely a summary of certain parts of the ApJ paper in much less detail. Please feel free to provide any feedback.

Since we've already submitted the ApJ paper, and since JOSS reviews focus a lot on the code-base, I plan to submit this tomorrow. If you would like more time to provide feedback, please let me know.

Many thanks!

dhomeier
dhomeier suggested changes Mar 8, 2023
View reviewed changes
Copy link
Contributor

@dhomeier dhomeier left a comment

Choose a reason for hiding this comment

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

Thanks, left a few spelling corrections etc. and suggestions on presentation, but I did not go very deep into the technical details.

joss_paper/paper.md Outdated Show resolved Hide resolved
joss_paper/paper.md Outdated Show resolved Hide resolved
joss_paper/paper.md Outdated Show resolved Hide resolved
joss_paper/paper.md Outdated Show resolved Hide resolved
joss_paper/paper.md Outdated Show resolved Hide resolved
joss_paper/paper.md Outdated Show resolved Hide resolved
@DanRyanIrish
Copy link
Member Author

Thanks, left a few spelling corrections etc. and suggestions on presentation, but I did not go very deep into the technical details.

Thanks @dhomeier!

@DanRyanIrish DanRyanIrish changed the title Joss paper ndcube Joss paper Mar 8, 2023
DanRyanIrish
DanRyanIrish commented Mar 8, 2023
View reviewed changes
joss_paper/paper.bib Show resolved Hide resolved
joss_paper/paper.md Outdated Show resolved Hide resolved
joss_paper/paper.md Outdated Show resolved Hide resolved
nabobalis
nabobalis approved these changes Mar 9, 2023
View reviewed changes
Copy link
Contributor

@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.

LGTM

@nabobalis
Copy link
Contributor

Would be nice if it was possible to see the rendered version before submission.

@DanRyanIrish DanRyanIrish force-pushed the joss branch 2 times, most recently from bdfe943 to dd2dc71 Compare March 9, 2023 09:52
@DanRyanIrish DanRyanIrish force-pushed the joss branch 4 times, most recently from f0e6802 to 466c3fc Compare March 9, 2023 10:07
@DanRyanIrish DanRyanIrish added this to the 2.1.1 milestone Mar 9, 2023
@DanRyanIrish DanRyanIrish added the No Changelog Entry Needed Skip all changelog checks. label Mar 9, 2023
@DanRyanIrish DanRyanIrish force-pushed the joss branch 2 times, most recently from 9ace0f0 to 4fd9dbb Compare March 9, 2023 10:44
@DanRyanIrish DanRyanIrish modified the milestones: 2.1.1, 2.1.2 Mar 9, 2023
@Cadair
Copy link
Member

Cadair commented Mar 9, 2023

Would be nice if it was possible to see the rendered version before submission

When you open the PR to JOSS you get the rendered version while they sort out reviewers etc, it's a very laid back process.

@DanRyanIrish
Copy link
Member Author

DanRyanIrish commented Mar 9, 2023 •
edited
Loading

Would be nice if it was possible to see the rendered version before submission.

Available as a zip file here: https://github.com/DanRyanIrish/ndcube/suites/11452622706/artifacts/590785240

@DanRyanIrish DanRyanIrish merged commit 2fb404b into sunpy:main Mar 9, 2023
@DanRyanIrish
Copy link
Member Author

I have just submitted this to JOSS. Thanks for all the input!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dhomeier dhomeier dhomeier requested changes

@Cadair Cadair Cadair approved these changes

@nabobalis nabobalis nabobalis approved these changes

Assignees
No one assigned
Labels
No Changelog Entry Needed Skip all changelog checks.
Projects
None yet
Milestone
2.1.2
Development

Successfully merging this pull request may close these issues.
4 participants
@DanRyanIrish @nabobalis @Cadair @dhomeier