Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign up[REVIEW]: Tamaas: a library for elastic-plastic contact of periodic rough surfaces #2121
Comments
Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @likask, @agshvarts, @srmnitc, @chennachaos it looks like you're currently assigned to review this paper 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:
For a list of things I can do to help you, just type:
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
|
|
@whedon generate pdf |
PDF failed to compile for issue #2121 with the following error: Error reading bibliography ./paper.bibtex (line 232, column 3): |
@whedon generate pdf |
|
Dear authors and reviewers We wanted to notify you that in light of the current COVID-19 pandemic, JOSS has decided to suspend submission of new manuscripts and to handle existing manuscripts (such as this one) on a "best efforts basis". We understand that you may need to attend to more pressing issues than completing a review or updating a repository in response to a review. If this is the case, a quick note indicating that you need to put a "pause" on your involvement with a review would be appreciated but is not required. Thanks in advance for your understanding. Arfon Smith, Editor in Chief, on behalf of the JOSS editorial team. |
@likask, @agshvarts, @srmnitc, @chennachaos - just a friendly check-in to see how things are going with your reviews? |
Hi @arfon Sorry for the delay, I started looking into it before the lockdown, and then got carried away. I will get back to it now. |
General checksContribution and authorship: The submitting author (@prs513rosewood) has clearly made the major contribution to the software (756 commits). However, regarding the list of authors, there is an AUTHORS file in the repository which lists two contributors who are not included as authors of the JOSS paper: Son Pham-Ba (49 commits) and Valentine Rey (18 commits). Furthermore, both of these contributors appeared as authors of a previous publication about this code on Zenodo (https://doi.org/10.5281/zenodo.3479237). Could the authors please justify the current choice of the authors' list for the JOSS paper and/or amend it? |
@agshvarts On OS X go with Docker installation, is quite smooth. Use Dockerfile from the tamaas repository. |
Hello @prs513rosewood, I run unit tests and code stuck with |
Hi @likask, for me this test is passing, but the one just after is failing, so that's probably why the code is stuck for you. I am on the current master branch and the commit message says that the tests are supposed to fail. To skip failing tests I run it as: |
Hi @likask @agshvarts and thanks for the feedback.
There was a problem with this test and docker (my Jenkins instance running the tests was also hanging on it, thanks to you I figured it was related to docker). I'm not sure what it was, but I refactored the test code and it seems to be working. That test is still kinda long (~30s) because the Stanley&Kato algorithm converges slowly to equilibrium.
These tests should now be passing. I was adding some new features this week and did not mean to push the commits I was working on. By the way, I made some changes to the way the main shared library is generated, so you may have to manually remove I also simplified the installation process. Running |
We have, with permission of everyone involved, amended the list of authors. The original choice was to have as authors the people who contributed to the elastic-plastic part of Tamaas, but since this publication should be the reference point for the library as a whole, and the paper mentions parts contributed by Valentine Rey and Son Pham-Ba, we have decided to include them (with their permission) on this publication. |
@whedon generate pdf |
@whedon check references |
@srmnitc, @chennachaos thanks for your help with this review. This is just a friendly check-in to see how things are going with your reviews. |
|
@likask, @agshvarts, thanks for your review efforts! |
@prs513rosewood, thank you for amending the author's list and for fixing issues with Docker. Now the installation, automatic testing, and all examples are working fine in Docker, so I ticked corresponding checkboxes. Below are my comments regarding the documentation. A statement of need. The authors are explaining clearly in the documentation the types of problems this software is aimed to solve. However, the target audience is not explicitly given, neither in the documentation nor in the paper. Could a short sentence describing the target audience be added to both documentation and the paper, which would make the purpose of this software more transparent for a broader computational mechanics/engineering community? Functionality documentation. C++ core API is thoroughly documented, however API reference of python wrappers is missing (only headings are visible). Since the core functionality is expected to be accessed using python interface (all examples of solving typical problems use python API), could it be possible to add some documentation for python wrappers too? It seems to be possible with pybind11 using Sphinx, see here. |
Thanks @agshvarts for the feedback. I've added the intended audience where suggested. For your second point, the Python API is documented via the |
@whedon generate pdf |
PDF failed to compile for issue #2121 with the following error: /app/vendor/ruby-2.4.4/lib/ruby/2.4.0/find.rb:43:in |
@whedon generate pdf |
PDF failed to compile for issue #2121 with the following error: /app/vendor/ruby-2.4.4/lib/ruby/2.4.0/find.rb:43:in |
@openjournals/dev can you help with these paper compilation issues? Thanks |
I was going to check the paper source, but I can't current get to https://c4science.ch/source/tamaas/repository/master/ I get errors like
|
That would be why Whedon can't compile the paper then... |
From c4science:
|
whedon commentedFeb 26, 2020
•
edited by agshvarts
Submitting author: @prs513rosewood (Lucas Frérot)
Repository: https://c4science.ch/source/tamaas/
Version: 2.0.0
Editor: @Kevin-Mattheus-Moerman
Reviewer: @likask, @agshvarts, @srmnitc, @chennachaos
Archive: Pending
Status
Status badge code:
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
@likask & @agshvarts & @srmnitc & @chennachaos, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:
The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @Kevin-Mattheus-Moerman know.
Review checklist for @likask
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
Review checklist for @agshvarts
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
Review checklist for @srmnitc
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
Review checklist for @chennachaos
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper