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

[REVIEW]: pytreegrav: a fast Python gravity solver #3675

Closed
40 tasks done
whedon opened this issue Aug 31, 2021 · 50 comments
Closed
40 tasks done

[REVIEW]: pytreegrav: a fast Python gravity solver #3675

whedon opened this issue Aug 31, 2021 · 50 comments
Assignees
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX

Comments

@whedon
Copy link

whedon commented Aug 31, 2021

Submitting author: @mikegrudic (Michael Grudi´c)
Repository: https://github.com/mikegrudic/pytreegrav
Version: 1.0.0
Editor: @dfm
Reviewer: @adrn, @maxwelltsai
Archive: 10.5281/zenodo.5807909

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

Status

status

Status badge code:

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

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

@adrn & @maxwelltsai, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

  1. Make sure you're logged in to your GitHub account
  2. Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @dfm 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

Review checklist for @adrn

✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@mikegrudic) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of Need' that clearly states what problems the software is designed to solve and who the target audience is?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

Review checklist for @maxwelltsai

✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@mikegrudic) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of Need' that clearly states what problems the software is designed to solve and who the target audience is?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?
@whedon
Copy link
Author

whedon commented Aug 31, 2021

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @adrn, @maxwelltsai it looks like you're currently assigned to review this paper 🎉.

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

⭐ Important ⭐

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿

To fix this do the following two things:

  1. Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews:

watching

  1. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

notifications

For a list of things I can do to help you, just type:

@whedon commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Aug 31, 2021

Wordcount for paper.md is 1239

@whedon
Copy link
Author

whedon commented Aug 31, 2021

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1145/2833157.2833162 is OK
- 10.1016/S1384-1076(96)00009-7 is OK
- 10.1093/mnras/staa2578 is OK
- 10.1006/jcph.1994.1050 is OK
- 10.1093/mnras/71.5.460 is OK
- 10.1088/0004-637X/762/2/109 is OK
- 10.1093/mnras/sty2303 is OK
- 10.1093/mnras/stz3527 is OK
- 10.1046/j.1365-8711.1999.02613.x is OK
- 10.1093/mnras/stv195 is OK
- 10.1111/j.1365-2966.2005.09655.x is OK
- 10.1093/mnras/stu1421 is OK
- 10.1093/mnras/sty1690 is OK
- 10.1140/epjp/i2011-11055-3 is OK
- 10.1038/324446a0 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Aug 31, 2021

Software report (experimental):

github.com/AlDanial/cloc v 1.88  T=0.06 s (285.5 files/s, 44248.4 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          12            256            399           1343
TeX                              1             27              0            263
Markdown                         2             65              0            143
Jupyter Notebook                 1              0            237             50
TOML                             1              0              0              6
YAML                             1              0              0              1
-------------------------------------------------------------------------------
SUM:                            18            348            636           1806
-------------------------------------------------------------------------------


Statistical information for the repository '4de020fcbc18a287478668eb' was
gathered on 2021/08/31.
The following historical commit information, by author, was found:

Author                     Commits    Insertions      Deletions    % of changes
Alex Gurvich                     7           862            557           23.38
Ben Keller                       4            33             16            0.81
Michael Grudic                  10           499             59            9.19
Mike Grudic                     27          2390           1215           59.39
Mike Grudić                      7           250            187            7.20
omgspace                         1             0              2            0.03

Below are the number of rows from each author that have survived and are still
intact in the current revision:

Author                     Rows      Stability          Age       % in comments
Alex Gurvich                132           15.3          1.5               11.36
Ben Keller                   18           54.5          1.3                0.00
Michael Grudic               45            9.0         47.2                0.00
Mike Grudic                1798           75.2          0.9                6.28
Mike Grudić                   5            2.0         20.9               20.00

@whedon
Copy link
Author

whedon commented Aug 31, 2021

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@dfm
Copy link

dfm commented Aug 31, 2021

@mikegrudic, @adrn, @maxwelltsai – This is the review thread for the paper. All of our communications will happen here from now on. Thanks again for agreeing to participate!

Please read the "Reviewer instructions & questions" in the first comment above.

Both reviewers have checklists at the top of this thread (in that first comment) with the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. There are also links to the JOSS reviewer guidelines.

The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, the reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention openjournals/joss-reviews#3675 so that a link is created to this thread (and I can keep an eye on what is happening). Please also feel free to comment and ask questions on this thread. In my experience, it is better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package.

We aim for the review process to be completed within about 4-6 weeks but please make a start well ahead of this as JOSS reviews are by their nature iterative and any early feedback you may be able to provide to the author will be very helpful in meeting this schedule.

@whedon
Copy link
Author

whedon commented Sep 14, 2021

👋 @maxwelltsai, please update us on how your review is going (this is an automated reminder).

@whedon
Copy link
Author

whedon commented Sep 14, 2021

👋 @adrn, please update us on how your review is going (this is an automated reminder).

@adrn
Copy link

adrn commented Sep 25, 2021

@mikegrudic The submitted paper is excellent: concise, clearly written, and I don't have any comments or edits to suggest - nice work! Comments on the code are in: mikegrudic/pytreegrav#12

@maxwelltsai
Copy link

@dfm @whedon It seems that the paper link is broken. I can no longer download the paper proof from this page: #3406 (comment)

Has it been transferred to somewhere else? I did find the paper.md file on the code repo, but I am wondering whether this is the paper itself.

@dfm
Copy link

dfm commented Sep 28, 2021

@maxwelltsai: There is a new link just a few comments up ☝️: #3675 (comment) That one's working for me - does it work for you too?

@maxwelltsai
Copy link

@mikegrudic, @dfm I have finished the review. Apart from the comments from @adrn, I have the following comments:

  • I would suggest that the authors add the dependent packages (e.g., numpy, numba) into their setup.py. This allows the dependency to automatically sorted out when the users install the package.
  • I assume that the library works with any version of Python 3.x. If the package requires a specific version of Python, it would be good to document this as well.
  • I notice that pytreegrav is already on PyPI. I would also suggest the authors to document in their GitHub repository (and also mention in the paper) that the package can be installed using PyPI: pip install pytreegrav. Some users may find it easier to directly install the package with pip rather than having to clone the code and run setup.py.
  • The authors have a test/ directory in their repository, but the test script there is intended for manual test by a human. It would be useful to create some structured automated unit test cases.
  • The package is designed for the specific purpose of calculating the potential and accelerations. I understand that it is a software library to be integrated into a Python N-body integrator, but it would be great if the authors could demonstrate this by implementing a simple integrator (e.g., LeapFrog) with pytreegrav. This can be done within a Jupyter notebook and/or a standalone python script. I would also suggest that the authors to add a directory examples/ in the root of their repository, which contains all these examples for new users to get started.
  • Since the authors use the JIT decorator in numpy to parallelise the computation on CPUs, is there any reason that they didn't try to use cuda.jit for GPU parallelisation?

@dfm
Copy link

dfm commented Oct 29, 2021

@mikegrudic: I wanted to check in on the status of this review. I see @adrn's open issue mikegrudic/pytreegrav#12, and @maxwelltsai's comment here. Any word on when you'll be able to respond to these comments? Thanks!

@mikegrudic
Copy link

Hi all, thanks a lot for the helpful input. Should be able to address and respond to comments within the next month. In particular proper documentation and potentially automated testing are forthcoming.

@mikegrudic
Copy link

Thanks to @maxwelltsai and @adrn for taking the time to give useful feedback. The package has been revised extensively, and in particular we now have sphinx documentation and an automated pytest test. This contains a lot of the additional content requested in your reviews. There is still a ways to go to fully document the codebase, but at least all of the frontend API functions are fully documented now. Further feedback on this is welcome.

Responding to some specific points apart from the general suggestion of expanded documentation, first by @adrn:

* I don't see any mention of what profile is used to soften the point mass potentials when `h` is provided. Is there a standard profile to use (i.e. Plummer?), or is this configurable? It would be good to explicitly state this in the documentation.

We mention in the paper that the softened force is that of a cubic M4 spline mass distribution and provide the reference for the specific mathematical expressions. We now also clarify this in the API documentation, where the respective softening arguments are documented.

* Though the details of code style can be subjective, Python packages generally at least follow the convention (laid out in PEP 8) that class names follow [the CapWords convention](https://www.python.org/dev/peps/pep-0008/#class-names) and [function names are lower case](https://www.python.org/dev/peps/pep-0008/#id43). Please consider reformatting the functions in this package to follow PEP8 guidelines.

In a vacuum I'd like to do this, but at this point I am disinclined for fear of causing headaches and confusion for the various projects that are already using this package, many of which I do not own.

And @maxwelltsai's points:

@mikegrudic, @dfm I have finished the review. Apart from the comments from @adrn, I have the following comments:

* I would suggest that the authors add the dependent packages (e.g., `numpy`, `numba`) into their `setup.py`. This allows the dependency to automatically sorted out when the users install the package.

Done.

* I assume that the library works with any version of Python 3.x. If the package requires a specific version of Python, it would be good to document this as well.
* I notice that `pytreegrav` is already on PyPI. I would also suggest the authors to document in their GitHub repository (and also mention in the paper) that the package can be installed using PyPI: `pip install pytreegrav`. Some users may find it easier to directly install the package with `pip` rather than having to clone the code and run `setup.py`.

Done, see the installation section of the documentation.

* The package is designed for the specific purpose of calculating the potential and accelerations. I understand that it is a software library to be integrated into a Python N-body integrator, but it would be great if the authors could demonstrate this by implementing a simple integrator (e.g., LeapFrog) with `pytreegrav`. This can be done within a Jupyter notebook and/or a standalone python script. I would also suggest that the authors to add a directory `examples/` in the root of their repository, which contains all these examples for new users to get started.

Done, see examples/Nbody_integrator.ipynb

* Since the authors use the JIT decorator in `numpy` to parallelise the computation on CPUs, is there any reason that they didn't try to use `cuda.jit` for GPU parallelisation?

Just that I've never personally been able to get numba's cuda interface working on any system of my own 🤷‍♂️ this is probably possible, because the tree structure is really a set of float/int arrays for which the Octree instance serves as a wrapper, so one could write a kernel that just accepts the unpacked arrays as arguments, and otherwise run the same loop as in the CPU treewalk functions. I encourage anyone interested to give this a shot.

@dfm
Copy link

dfm commented Dec 14, 2021

👋 Pinging @adrn and @maxwelltsai to take a look at @mikegrudic's response to your comments ☝️

@adrn
Copy link

adrn commented Dec 16, 2021

Thanks @mikegrudic for addressing my comments! Your responses above are reasonable and the new documentation site looks good. I'm satistifed!

@maxwelltsai
Copy link

Thanks @mikegrudic for addressing my comments. On my side I am happy to recommend the paper for publication.

@dfm
Copy link

dfm commented Dec 17, 2021

@adrn, @maxwelltsai: Thanks for your updates. Can you both go through your checklists up at the top of this thread, because I'm still seeing a lot of un-checked boxes. Thanks!

@dfm
Copy link

dfm commented Dec 27, 2021

@whedon check references

@whedon
Copy link
Author

whedon commented Dec 27, 2021

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1145/2833157.2833162 is OK
- 10.1016/S1384-1076(96)00009-7 is OK
- 10.1093/mnras/staa2578 is OK
- 10.1006/jcph.1994.1050 is OK
- 10.1093/mnras/71.5.460 is OK
- 10.1088/0004-637X/762/2/109 is OK
- 10.1093/mnras/sty2303 is OK
- 10.1093/mnras/stz3527 is OK
- 10.1046/j.1365-8711.1999.02613.x is OK
- 10.1093/mnras/stv195 is OK
- 10.1111/j.1365-2966.2005.09655.x is OK
- 10.1093/mnras/stu1421 is OK
- 10.1093/mnras/sty1690 is OK
- 10.1140/epjp/i2011-11055-3 is OK
- 10.1038/324446a0 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@dfm
Copy link

dfm commented Dec 27, 2021

@whedon generate pdf

@mikegrudic
Copy link

@dfm thanks for your work on this. I have incremented the version to 1.0.0, and have uploaded the version to zenodo: 10.5281/zenodo.5807909

@dfm
Copy link

dfm commented Dec 28, 2021

@whedon set 1.0.0 as version

@whedon
Copy link
Author

whedon commented Dec 28, 2021

OK. 1.0.0 is the version.

@dfm
Copy link

dfm commented Dec 28, 2021

@whedon set 10.5281/zenodo.5807909 as archive

@whedon
Copy link
Author

whedon commented Dec 28, 2021

OK. 10.5281/zenodo.5807909 is the archive.

@dfm
Copy link

dfm commented Dec 28, 2021

@whedon recommend-accept

@whedon
Copy link
Author

whedon commented Dec 28, 2021

Attempting dry run of processing paper acceptance...

@whedon whedon added the recommend-accept Papers recommended for acceptance in JOSS. label Dec 28, 2021
@whedon
Copy link
Author

whedon commented Dec 28, 2021

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1145/2833157.2833162 is OK
- 10.1016/S1384-1076(96)00009-7 is OK
- 10.1093/mnras/staa2578 is OK
- 10.1006/jcph.1994.1050 is OK
- 10.1093/mnras/71.5.460 is OK
- 10.1088/0004-637X/762/2/109 is OK
- 10.1093/mnras/sty2303 is OK
- 10.1093/mnras/stz3527 is OK
- 10.1046/j.1365-8711.1999.02613.x is OK
- 10.1093/mnras/stv195 is OK
- 10.1111/j.1365-2966.2005.09655.x is OK
- 10.1093/mnras/stu1421 is OK
- 10.1093/mnras/sty1690 is OK
- 10.1140/epjp/i2011-11055-3 is OK
- 10.1038/324446a0 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Dec 28, 2021

PDF failed to compile for issue #3675 with the following error:

 /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon/author.rb:72:in `block in build_affiliation_string': Problem with affiliations for Michael Grudić, perhaps the affiliations index need quoting? (RuntimeError)
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon/author.rb:71:in `each'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon/author.rb:71:in `build_affiliation_string'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon/author.rb:17:in `initialize'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon.rb:205:in `new'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon.rb:205:in `block in parse_authors'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon.rb:202:in `each'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon.rb:202:in `parse_authors'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon.rb:93:in `initialize'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon/processor.rb:38:in `new'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon/processor.rb:38:in `set_paper'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/bin/whedon:87:in `compile'
	from /app/vendor/bundle/ruby/2.6.0/gems/thor-0.20.3/lib/thor/command.rb:27:in `run'
	from /app/vendor/bundle/ruby/2.6.0/gems/thor-0.20.3/lib/thor/invocation.rb:126:in `invoke_command'
	from /app/vendor/bundle/ruby/2.6.0/gems/thor-0.20.3/lib/thor.rb:387:in `dispatch'
	from /app/vendor/bundle/ruby/2.6.0/gems/thor-0.20.3/lib/thor/base.rb:466:in `start'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/bin/whedon:131:in `<top (required)>'
	from /app/vendor/bundle/ruby/2.6.0/bin/whedon:23:in `load'
	from /app/vendor/bundle/ruby/2.6.0/bin/whedon:23:in `<main>'

@dfm
Copy link

dfm commented Dec 28, 2021

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Dec 28, 2021

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@dfm
Copy link

dfm commented Dec 28, 2021

@whedon recommend-accept

@whedon
Copy link
Author

whedon commented Dec 28, 2021

Attempting dry run of processing paper acceptance...

@whedon
Copy link
Author

whedon commented Dec 28, 2021

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1145/2833157.2833162 is OK
- 10.1016/S1384-1076(96)00009-7 is OK
- 10.1093/mnras/staa2578 is OK
- 10.1006/jcph.1994.1050 is OK
- 10.1093/mnras/71.5.460 is OK
- 10.1088/0004-637X/762/2/109 is OK
- 10.1093/mnras/sty2303 is OK
- 10.1093/mnras/stz3527 is OK
- 10.1046/j.1365-8711.1999.02613.x is OK
- 10.1093/mnras/stv195 is OK
- 10.1111/j.1365-2966.2005.09655.x is OK
- 10.1093/mnras/stu1421 is OK
- 10.1093/mnras/sty1690 is OK
- 10.1140/epjp/i2011-11055-3 is OK
- 10.1038/324446a0 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Dec 28, 2021

👋 @openjournals/joss-eics, this paper is ready to be accepted and published.

Check final proof 👉 openjournals/joss-papers#2851

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#2851, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true

@dfm
Copy link

dfm commented Dec 28, 2021

@mikegrudic: Thanks for all your work here! I've handed this off to the EiC team who may have some final edits before processing for publication. Thanks for your submission and your participation in this process!!

@adrn, @maxwelltsai: I really appreciate the time that you volunteered here, and for your thorough and constructive reviews. We couldn't do this without you, so thanks so much for your help!

@mikegrudic
Copy link

Thanks again everyone!

@arfon
Copy link
Member

arfon commented Dec 28, 2021

@whedon accept deposit=true

@whedon whedon added accepted published Papers published in JOSS labels Dec 28, 2021
@whedon
Copy link
Author

whedon commented Dec 28, 2021

Doing it live! Attempting automated processing of paper acceptance...

@whedon
Copy link
Author

whedon commented Dec 28, 2021

🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦

@whedon
Copy link
Author

whedon commented Dec 28, 2021

🚨🚨🚨 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 👉 Creating pull request for 10.21105.joss.03675 joss-papers#2852
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.03675
  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...

@arfon
Copy link
Member

arfon commented Dec 28, 2021

@adrn, @maxwelltsai – many thanks for your reviews here and to @dfm for editing this submission! JOSS relies upon the volunteer effort of people like you and we simply wouldn't be able to do this without you ✨

@mikegrudic – your paper is now accepted and published in JOSS ⚡🚀💥

@arfon arfon closed this as completed Dec 28, 2021
@whedon
Copy link
Author

whedon commented Dec 28, 2021

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

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.03675/status.svg)](https://doi.org/10.21105/joss.03675)

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

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

This is how it will look in your documentation:

DOI

We need your help!

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:

@arfon
Copy link
Member

arfon commented Dec 30, 2021

Also, I meant to say that this was JOSS' 1500th published paper! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review TeX
Projects
None yet
Development

No branches or pull requests

6 participants