[PRE REVIEW]: rdbsp: An Open Source Rock Dynamic Behavior Simulation Program

[whedon]

Submitting author: @zhangning737 (Zhang Ning) Repository: https://github.com/zhangning737/rdbsp.git Version: v1.0.0 Editor: @lheagy Reviewers: @dvalters

Author instructions

Thanks for submitting your paper to JOSS @zhangning737. The JOSS editor (shown at the top of this issue) will work with you on this issue to find a reviewer for your submission before creating the main review issue.

@zhangning737 if you have any suggestions for potential reviewers then please mention them here in this thread. In addition, this list of people have already agreed to review for JOSS and may be suitable for this submission.

Editor instructions

The JOSS submission bot @whedon is here to help you find and assign reviewers and start the main review. To find out what @whedon can do for you type:

@whedon commands

[whedon]

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks.

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

@whedon commands

What happens now?

This submission is currently in a pre-review state which means we are waiting for an editor to be assigned and for them to find some reviewers for your submission. This may take anything between a few hours to a couple of weeks. Thanks for your patience :smile_cat:

You can help the editor by looking at this list of potential reviewers to identify individuals who might be able to review your submission (please start at the bottom of the list). Also, feel free to suggest individuals who are not on this list by mentioning their GitHub handles here.

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

Failed to discover a valid open source license.

[whedon]

:point_right: Check article proof :page_facing_up: :point_left:

[danielskatz]

@whedon set https://github.com/zhangning737/rdbsp as repository

[danielskatz]

👋 @zhangning737 - there is going to need to be quite a bit more information in the README. For example, I was going to use that to assign an editor, which I can't do without having some idea what this software does. Some of the content from the paper probably needs to be copied into the README. You also might want to look at the review criteria (see documentation) to see what else you should be adding.

[danielskatz]

👋 @lheagy - I think you are the best-suited editor for this submission - can you handle it?

[lheagy]

Thanks @danielskatz: I don't have much experience with C / C++ , but I would be happy to be the editor on this submission

[lheagy]

@whedon assign @lheagy as editor

[whedon]

OK, the editor is @lheagy

[lheagy]

👋 Hi @zhangning737, thanks for your submission to JOSS. Before we send this out for review, please have a look at the JOSS review criteria. Specifically,

• [x] an OSI approved license needs to be included in the repository
• [ ] documentation for the software should be provided. This should include
  • [x] a statement of need
  • [x] installation instructions
  • [ ] example usage
  • [x] API documentation
  • [ ] community guidelines
  • [x] functionality
  • [ ] tests
• [x] the README should include a high level overview of the documentation that includes

Please have a look as some of the other accepted JOSS submissions, e.g.:

• Ising_OPV v4.0: Experimental Tomography Data Import, Interpretation, and Analysis
• Lithology: A Landlab submodule for spatially variable rock properties

For now, I will tag this submission as pending enhancements. Please keep me posted on your progress and once these items are addressed, we can work on finding reviewers.

[lheagy]

👋 Hi @zhangning737, just checking in. Do you intend to make the changes suggested above? If so, I will leave this issue open. If not, I will close this and you can always re-open the issue and re-start the submission when these items are addressed

[lheagy]

:wave: Hi again @zhangning737, just checking in after the holidays. Do you plan to make the suggested changes as listed above? Thank you!

[lheagy]

👋 Hi @zhangning737, checking in again. Are you planning to make the changes as suggested above? If so, please leave a comment here to let me know.

[zhangning737]

@lheagy thank you for you message. I will prepare it now.

[zhangning737]

@lheagy update the repo with documentation and READ.md. pls check it. I wish those qualified. Any else needed? Thanks.

[lheagy]

Thanks @zhangning737, I will take a look in the next couple of days.

[lheagy]

Thanks for your updates @zhangning737, there are still a few things that I did not see:

• [ ] an explanation of how to run an example
• [ ] an explanation of how to run the tests. Note that the tests need to be distinct from the example usage. Tests should provide some objective way to make sure that the code is functioning as expected.
• [ ] a statement of need should be included in the README (the intro of your paper contains good motivation, so this can essentially be used
• [ ] community guidelines (e.g. along the lines of https://github.com/MikeHeiber/Ising_OPV/blob/master/CONTRIBUTING.md)

Please let me know when you have had a chance to address these

[zhangning737]

@lheagy thank you for comments, I'll check and revise the docs.

[lheagy]

Thanks @zhangning737, please ping here when you have made the changes.

[zhangning737]

@lheagy taken days for reediting tests and examples, fixed.

I have submited new tests and example and add to documentation, also updated README and CONTRIBUTING. pls check it.

Thx.

Wish docs completed this time.

[lheagy]

👋 Hi @dvalters, @trallard, would you be willing to review this submission for JOSS?

[dvalters]

Hi @lheagy :wave:, sure, I can review this.

[lheagy]

@whedon assign @dvalters as reviewer

[whedon]

OK, the reviewer is @dvalters

[lheagy]

Many thanks @dvalters! I will wait to hear back from @trallard before starting the review.

[trallard]

Hi @lheagy I am sorry but I have other two reviews in process and I do not have the time now to take up on a third one

[lheagy]

Hi @trallard, no problem. Thanks for getting back to me. Best of luck with your other reviews!

[lheagy]

:wave: Hi @harpolea, would you be willing to review this submission for JOSS?

[harpolea]

Hi @lheagy, I'm afraid I'm going to be busy travelling this month, so do not think I'd have the necessary time to review this properly (especially as I only have limited access to machines with the Intel compilers required). I also do not have much experience with finite element codes or solid mechanics, so do not think I'd be the best person to look at this.

[lheagy]

Thanks for getting back to me @harpolea. Safe travels!

[lheagy]

👋 Hi @nnadeau, would you be willing to review this submission for JOSS?

[engnadeau]

hi @lheagy, unfortunately i'm not available at this time

[dvalters]

Is this something @sgrieve might be available to review?

[sgrieve]

I'm afraid I don't have time at present, I'm about to do a block of field teaching. If you can't find anyone else give me a shout in 2 weeks and I'll see what I can do.

[lheagy]

Thanks @sgrieve, I will start the review process now with @dvalters as the reviewer so he can get started. If I can't find someone else in the next two weeks, I will check in with you again.

[lheagy]

@whedon start review

[whedon]

OK, I've started the review over in https://github.com/openjournals/joss-reviews/issues/1328. Feel free to close this issue now!