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

[DO NOT MERGE] Draft JOSS paper #107

Closed
wants to merge 51 commits into from
Closed

[DO NOT MERGE] Draft JOSS paper #107

wants to merge 51 commits into from

Conversation

sloede
Copy link
Member

@sloede sloede commented Oct 16, 2024

WARNING: DO NOT MERGE THIS PR!

This PR is to facilitate writing an initial JOSS paper on HOHQMesh. It should not be merged (ever!). Instead, once the paper is accepted, this PR can be closed without deleting the branch. The branch paper-2024-joss will just stay around forever.

Latest build of paper.pdf: view, download


Based on the TODO list in openjournals/joss-reviews#7476:

  • Double check authors and affiliations (including ORCIDs)
  • Review and merge Small edits for JOSS review #124.
  • Make a release of the software with the latest changes from the review.
  • Archive the release on Zenodo/figshare/etc.
  • Make sure that the title and author list (including ORCIDs) in the archive match those in the JOSS paper.
  • Make sure that the license listed for the archive is the same as the software license.
  • Post the version number and the DOI number in the JOSS review issue. This is the version that will be used in the JOSS paper.

Copy link

codecov bot commented Oct 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.83%. Comparing base (0500295) to head (069167e).
Report is 17 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #107      +/-   ##
==========================================
+ Coverage   74.88%   75.83%   +0.94%     
==========================================
  Files          68       68              
  Lines       10429    10568     +139     
  Branches        2        2              
==========================================
+ Hits         7810     8014     +204     
+ Misses       2619     2554      -65     
Flag Coverage Δ
unittests 75.83% <ø> (+0.94%) ⬆️

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.

@andrewwinters5000
Copy link
Member

I have put in most of the suggestions from the group into the draft. We are over the word limit as currently we are at 1132 and the max JOSS allows is 1000. This is one reason I trimmed down the suggested description of HOHQMesh.jl.

Apart from editing, the remaining things that need done are:

  1. Zenodo for HOHQMesh and HOHQMesh.jl
  2. Decide on any additional references to add that use HOHQMesh meshes.

Use format suggested by JOSS for github repositories.
Remove a couple of sentences to bring word count below 1K
Add a clarification on what is meshed.
@ranocha
Copy link
Member

ranocha commented Oct 19, 2024

I have never seen a JOSS review process where the number of words was an issue. The formulation

The paper should be between 250-1000 words. Authors submitting papers significantly longer than 1000 words may be asked to reduce the length of their paper.

sounds to me like we don't have to reduce the number of words if we slightly exceed 1000 words.

andrewwinters5000 and others added 11 commits October 24, 2024 10:04
Add citations in the "Statement of Need" section with papers published with meshes from HOHQMesh.
Remove flow computation figure. Add links to the Malpasset control file, the gallery and the examples. Mention that meshes are generated as part of the test operation.
This reverts commit fd3c838.
* Update paper.md

Remove flow computation figure. Add links to the Malpasset control file, the gallery and the examples. Mention that meshes are generated as part of the test operation.

* Update paper.md

Add flow computation back in.

---------

Co-authored-by: David Kopriva <[email protected]>
* Small edits

* Update paper.md

Co-authored-by: Michael Schlottke-Lakemper <[email protected]>

---------

Co-authored-by: Andrew Winters <[email protected]>
Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
* Update paper.md

* Update paper.bib
@andrewwinters5000
Copy link
Member

Nice work everyone! The paper is now published and available at https://doi.org/10.21105/joss.07476. I will close this PR but not delete the branch.

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.

7 participants