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.

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

Add JOSS paper. #43

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

Add JOSS paper. #43

wants to merge 7 commits into from

Conversation

vnmabus
Copy link
Owner

@vnmabus vnmabus commented Aug 31, 2024

Describe the proposed changes

This adds a paper to the repo, so that we can submit it to JOSS.

@trossi I had to rewrite part of the text that I had, as it was for an older version (prior to pyOpenSci submission). It can probably (almost surely, I would say) be improved, in case you have suggestions to do so.
Other things to take into account:

  • Please review your author info. I tried to add your ORCID and affiliation, but it may be incorrect.
  • Please add your acknowledgements (funding or whatever you need).
  • Please feel free to add the work in which you used the library at the end of the "Statement of need" section.
  • I left the section "Ongoing work" (name can be changed) for you to explain the changes you did.
  • You can compile locally using the Docker they provide (https://joss.readthedocs.io/en/latest/paper.html#docker). I also set up the Github action, to check the paper after you push (e.g. https://github.com/vnmabus/rdata/actions/runs/10648562090).

You can add your changes either as suggestions to this PR or as PRs against this branch.

Copy link
Contributor

@trossi trossi left a comment

Choose a reason for hiding this comment

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

@vnmabus Thank you! I have added a description of the writing functionality and some general suggestions.

paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Show resolved Hide resolved
paper/paper.bib Outdated Show resolved Hide resolved
paper/paper.bib Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
Copy link
Owner Author

@vnmabus vnmabus left a comment

Choose a reason for hiding this comment

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

I agree with all your suggestions. I commit them and will re-read the article to see if more improvements need to be made. I suggest you to do the same if/when you have time.

paper/paper.bib Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
Co-authored-by: Tuomas Rossi <34502776+trossi@users.noreply.github.com>
paper/paper.bib Outdated Show resolved Hide resolved
paper/paper.bib Outdated Show resolved Hide resolved
paper/paper.bib Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.bib Outdated Show resolved Hide resolved
@trossi
Copy link
Contributor

trossi commented Sep 11, 2024

I agree with all your suggestions. I commit them and will re-read the article to see if more improvements need to be made. I suggest you to do the same if/when you have time.

Thank you! I added the changes related to discussion on paper.bib. I re-read the article and I think it's in good state. I can have another look later this week.

Copy link
Contributor

@trossi trossi left a comment

Choose a reason for hiding this comment

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

I added a small suggestion including references to NumPy and Pandas publications.

paper/paper.bib Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
Accepted changes from code review:
- Updated references
- Set Zenodo DOIs to "all versions" DOI
- Add references to NumPy and Pandas

Co-authored-by: Tuomas Rossi <34502776+trossi@users.noreply.github.com>
@codecov-commenter
Copy link

codecov-commenter commented Sep 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.98%. Comparing base (a16f99a) to head (5174536).
Report is 130 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop      #43      +/-   ##
===========================================
+ Coverage    89.20%   93.98%   +4.78%     
===========================================
  Files           10       17       +7     
  Lines         1176     1629     +453     
===========================================
+ Hits          1049     1531     +482     
+ Misses         127       98      -29     
Flag Coverage Δ
93.98% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Owner Author

@vnmabus vnmabus left a comment

Choose a reason for hiding this comment

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

I just re-read the article again and added some suggestions. Please @trossi give me your opinion on these when you have time.

paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
Copy link
Contributor

@trossi trossi left a comment

Choose a reason for hiding this comment

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

@vnmabus I agree with all your suggestions. I added a few comments and small suggestions.

paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
vnmabus and others added 2 commits October 7, 2024 21:32
Co-authored-by: Tuomas Rossi <34502776+trossi@users.noreply.github.com>
Co-authored-by: Tuomas Rossi <34502776+trossi@users.noreply.github.com>
paper/paper.md Show resolved Hide resolved
Co-authored-by: Tuomas Rossi <34502776+trossi@users.noreply.github.com>
paper/paper.md Outdated Show resolved Hide resolved
Co-authored-by: Tuomas Rossi <34502776+trossi@users.noreply.github.com>
@vnmabus
Copy link
Owner Author

vnmabus commented Oct 27, 2024

@trossi , I just sent the submission to JOSS.

@trossi
Copy link
Contributor

trossi commented Oct 28, 2024

@vnmabus Great! Thank you!

@vnmabus
Copy link
Owner Author

vnmabus commented Dec 2, 2024

@trossi In case you need it for your CV: it seems that the article was fast-tracked... well, really fast 😅️: https://joss.theoj.org/papers/10.21105/joss.07540

I will merge this and make the necessary edits in the repo in the following days.

@trossi
Copy link
Contributor

trossi commented Dec 4, 2024

@vnmabus Great, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants