openjournals / joss-reviews

Reviews for the Journal of Open Source Software
Creative Commons Zero v1.0 Universal
721 stars 38 forks source link

[REVIEW]: 'HallThruster.jl: a Julia package for 1D Hall thruster discharge simulation' #4672

Closed editorialbot closed 1 year ago

editorialbot commented 2 years ago

Submitting author: !--author-handle-->@archermarx<!--end-author-handle-- (Thomas Marks) Repository: https://github.com/UM-PEPL/HallThruster.jl Branch with paper.md (empty if default branch): Version: v0.8.3 Editor: !--editor-->@lucydot<!--end-editor-- Reviewers: @Rupali-Sahu, @TomGoffrey, @lucydot Archive: 10.5281/zenodo.8066246

Status

status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/ce9cb7aa54df10d69ed248912e584f53"><img src="https://joss.theoj.org/papers/ce9cb7aa54df10d69ed248912e584f53/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/ce9cb7aa54df10d69ed248912e584f53/status.svg)](https://joss.theoj.org/papers/ce9cb7aa54df10d69ed248912e584f53)

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@StanczakDominik & @Rupali-Sahu, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review. First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @lucydot know.

✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨

Checklists

πŸ“ Checklist for @Rupali-Sahu

πŸ“ Checklist for @TomGoffrey

πŸ“ Checklist for @lucydot

archermarx commented 1 year ago

On it!

Done!

Done. The version is v0.8.3

Done! doi.org/10.5281/zenodo.8066246.

Done!

Done!

lucydot commented 1 year ago

@editorialbot generate pdf

lucydot commented 1 year ago

@editorialbot set v0.8.3 as version

editorialbot commented 1 year ago

Done! version is now v0.8.3

lucydot commented 1 year ago

@editorialbot set 10.5281/zenodo.8066246 as archive

editorialbot commented 1 year ago

Done! archive is now 10.5281/zenodo.8066246

editorialbot commented 1 year ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

lucydot commented 1 year ago

@editorialbot check references

editorialbot commented 1 year ago
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1063/5.0021474 is OK
- 10.2514/6.2001-3505 is OK
- 10.1088/1361-6595/ab0f70 is OK
- 10.1063/1.368529 is OK
- 10.1063/1.1371519 is OK
- 10.1088/0963-0252/14/4/011 is OK
- 10.1063/1.5055750 is OK
- 10.1002/9780470436448.ch7 is OK
- 10.1063/1.4972269 is OK
- 10.1145/3511528.3511535 is OK
- 10.1137/141000671 is OK

MISSING DOIs

- None

INVALID DOIs

- None
lucydot commented 1 year ago

Great work @archermarx, all looks good to me, I'm going to recommend acceptance 🎈

lucydot commented 1 year ago

@editorialbot recommend-accept

editorialbot commented 1 year ago
Attempting dry run of processing paper acceptance...
editorialbot commented 1 year ago
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1063/5.0021474 is OK
- 10.2514/6.2001-3505 is OK
- 10.1088/1361-6595/ab0f70 is OK
- 10.1063/1.368529 is OK
- 10.1063/1.1371519 is OK
- 10.1088/0963-0252/14/4/011 is OK
- 10.1063/1.5055750 is OK
- 10.1002/9780470436448.ch7 is OK
- 10.1063/1.4972269 is OK
- 10.1145/3511528.3511535 is OK
- 10.1137/141000671 is OK

MISSING DOIs

- None

INVALID DOIs

- None
editorialbot commented 1 year ago

:wave: @openjournals/pe-eics, this paper is ready to be accepted and published.

Check final proof :point_right::page_facing_up: Download article

If the paper PDF and the deposit XML files look good in https://github.com/openjournals/joss-papers/pull/4355, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

kyleniemeyer commented 1 year ago

Hello @archermarx, I've made some typographic and formatting edits to the paperβ€”could you please merge this PR? https://github.com/UM-PEPL/HallThruster.jl/pull/85

Also, can you please take a look at the Landmark 1D fluid test case reference, and check whether there are more-appropriate data to include in the citation than just a URL? For example, at minimum I imagine there are author/contributor names and date.

archermarx commented 1 year ago

Thanks @kyleniemeyer. I've merged the pull request, and added author information and a date for the LANDMARK benchmark citation.

kyleniemeyer commented 1 year ago

@editorialbot generate pdf

editorialbot commented 1 year ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

kyleniemeyer commented 1 year ago

@editorialbot accept

editorialbot commented 1 year ago
Doing it live! Attempting automated processing of paper acceptance...
editorialbot commented 1 year ago

Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository.

If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file.

You can copy the contents for your CITATION.cff file here:

CITATION.cff

``` cff-version: "1.2.0" authors: - family-names: Marks given-names: Thomas orcid: "https://orcid.org/0000-0003-3614-6127" - family-names: Schedler given-names: Paul - family-names: Jorns given-names: Benjamin orcid: "https://orcid.org/0000-0001-9296-2044" doi: 10.5281/zenodo.8066246 message: If you use this software, please cite our article in the Journal of Open Source Software. preferred-citation: authors: - family-names: Marks given-names: Thomas orcid: "https://orcid.org/0000-0003-3614-6127" - family-names: Schedler given-names: Paul - family-names: Jorns given-names: Benjamin orcid: "https://orcid.org/0000-0001-9296-2044" date-published: 2023-06-28 doi: 10.21105/joss.04672 issn: 2475-9066 issue: 86 journal: Journal of Open Source Software publisher: name: Open Journals start: 4672 title: "HallThruster.jl: a Julia package for 1D Hall thruster discharge simulation" type: article url: "https://joss.theoj.org/papers/10.21105/joss.04672" volume: 8 title: "HallThruster.jl: a Julia package for 1D Hall thruster discharge simulation" ```

If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation.

Find more information on .cff files here and here.

editorialbot commented 1 year ago

🐘🐘🐘 πŸ‘‰ Toot for this paper πŸ‘ˆ 🐘🐘🐘

editorialbot commented 1 year ago

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited :point_right: https://github.com/openjournals/joss-papers/pull/4360
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.04672
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! πŸŽ‰πŸŒˆπŸ¦„πŸ’ƒπŸ‘»πŸ€˜

Any issues? Notify your editorial technical team...

kyleniemeyer commented 1 year ago

Congratulations @archermarx on your article's publication in JOSS! Please consider signing up as a reviewer to help us in the future, if you haven't already.

Many thanks to @Rupali-Sahu and @TomGoffrey for reviewing this submission, and @lucydot for editing.

editorialbot commented 1 year ago

:tada::tada::tada: Congratulations on your paper acceptance! :tada::tada::tada:

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://joss.theoj.org/papers/10.21105/joss.04672/status.svg)](https://doi.org/10.21105/joss.04672)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.04672">
  <img src="https://joss.theoj.org/papers/10.21105/joss.04672/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.04672/status.svg
   :target: https://doi.org/10.21105/joss.04672

This is how it will look in your documentation:

DOI

We need your help!

The Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:

archermarx commented 1 year ago

Thanks everyone!