Joss-reviews: [PRE REVIEW]: pyFBS: A Python package for Frequency Based Substructuring

Created on 20 Aug 2020  路  44Comments  路  Source: openjournals/joss-reviews

Submitting author: @tb93 (Toma啪 Bregar)
Repository: https://gitlab.com/pyFBS/pyFBS
Version: 0.1.1
Editor: @kyleniemeyer
Reviewers: @ngoiz
Managing EiC: Kevin M. Moerman

:warning: JOSS reduced service mode :warning:

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.

Author instructions

Thanks for submitting your paper to JOSS @tb93. Currently, there isn't an JOSS editor assigned to your paper.

@tb93 if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). In addition, this list of people have already agreed to review for JOSS and may be suitable for this submission (please start at the bottom of the list).

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
Python TeX pre-review

All 44 comments

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

:warning: JOSS reduced service mode :warning:

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.

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

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

Can't find any papers to compile :-(

Failed to discover a Statement of need section in paper

Software report (experimental):

github.com/AlDanial/cloc v 1.84  T=2.09 s (35.3 files/s, 260214.9 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Jupyter Notebook                21              0         536826           1980
Python                          14            820           1136           1683
reStructuredText                31            719            750            512
TeX                              1             14              0            112
Markdown                         1             20              0             80
HTML                             1              5              0             28
DOS Batch                        1              8              1             27
YAML                             2              9             17             25
CSS                              1              4              4             13
make                             1              4              6             10
-------------------------------------------------------------------------------
SUM:                            74           1603         538740           4470
-------------------------------------------------------------------------------


Statistical information for the repository '2588' was gathered on 2020/08/20.
The following historical commit information, by author, was found:

Author                     Commits    Insertions      Deletions    % of changes
Locke-D-A                        3         10921          10287           23.56
Miha Kodri膷                      3          1044           1044            2.32
Toma啪 Bregar                    85         33669          32073           73.03
mihakodric                      12           495            412            1.01
tb93                             2            59             21            0.09

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
Locke-D-A                     2            0.0          1.9                0.00
Toma啪 Bregar               3448           10.2          3.1               13.98
mihakodric                  189           38.2          2.2                1.59

@openjournals/dev whedon cannot find the paper, which is here: https://gitlab.com/pyFBS/pyFBS/-/tree/master/joss, is this because they should move it out of that joss folder?

I tested the paper compilation with https://whedon.theoj.org/ and the PDF in fact compiles successfully (
od30rut28esfdu4jhjeg.pdf).

@whedon generate pdf

@openjournals/dev whedon cannot find the paper, which is here: https://gitlab.com/pyFBS/pyFBS/-/tree/master/joss, is this because they should move it out of that joss folder?

Whedon was struggling here as the repository is very large (> 1Gb) so I think the git clone timed out.

@tomazbregar - you should consider reducing the size of this repository if you can, this will be a benefit for your future users and will help the JOSS review process go more smoothly :-)

Also, the paper needs a little work; see the section of our Documentation about the Software paper. We need:

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: Do the authors clearly state 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?

The Statement of need is now a required section of the paper.

@arfon - sorry for the large repository size, I forgot to clean the old datasets. The new updated repository contains only relevant data and its much smaller (< 100 Mb).

@labarba - I rewrote the Summary and added a section Statement of need to the paper (branch name joss_paper). Regarding the state of the field, as pointed out in the paper, there is currently no opensource package to support the use of dynamic substructuring methodologies. For the 3D display part, it is supported by numerous opensource packages but the specific routines needed in DS are not supported.

@arfon - sorry for the large repository size, I forgot to clean the old datasets. The new updated repository contains only relevant data and its much smaller (< 100 Mb).

:+1: great!

@whedon generate pdf

In the statement of need section, I see a "dnamic" that should be "dynamic". Also, can you add a little about of the kind of problems that can be solved with this software, and the kinds of researchers who need to solve them, remembering that the editors/reviewers/readers are a very diverse group in terms of their disciplinary expertise.

馃憢 @kyleniemeyer - would you be willing to take this as the editor?

@whedon invite @kyleniemeyer as editor

@kyleniemeyer has been invited to edit this submission.

馃憢 @bstabler - would you be able to edit this submission? @kyleniemeyer thinks you are a better fit than him, but if not, he will edit it

@whedon invite @bstabler as editor

@bstabler has been invited to edit this submission.

@danielskatz - Sorry for the grammatical error, I only had it corrected on the branch joss_paper, I have now moved the up-to-date version to master branch.

@whedon generate pdf

@tomazbregar - the paper still does not say what specific types of problems it can solve, as I wrote previously

Also, can you add a little about of the kind of problems that can be solved with this software, and the kinds of researchers who need to solve them, remembering that the editors/reviewers/readers are a very diverse group in terms of their disciplinary expertise.

@danielskatz - My mistake, I forgot to include the explanation. The paper now contains a paragraph which briefly explains in which field the software is intended to be used (in Statement of need section).

@whedon generate pdf

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

@danielskatz - I just read the paper and I don't think it's a good fit for my expertise.

@tomazbregar - I noticed a typo in the paper - "opensource" needs a space.

@bstabler - Thank you for spotting the typo, I have corrected it in the paper.

Thanks - The currently on-duty AEiC will take over on the editor assignment

@whedon assign @kyleniemeyer as editor

OK, the editor is @kyleniemeyer

Hi @tomazbregar, I will now be starting to find reviewers for your submission. Do you have any reviewer suggestions?

Hey @kyleniemeyer, unfortunately I don't know who would be the best fit for reviewer. If it helps, the person should have a background in structural dynamics.

Dear @kyleniemeyer, perhaps potential reviewers could be ngoiz ([email protected]) and chennachaos ([email protected]).

:wave: @kyleniemeyer - it looks like this submission is still waiting on you to identify reviewers?

Hello @ngoiz and @chennachaos, would you be available to review this submission for JOSS, the Journal of Open Source Software?

Hi @kyleniemeyer, happy to help out and review this for JOSS!

@whedon add @ngoiz as reviewer

OK, @ngoiz is now a reviewer

Hi @kyleniemeyer. Thank you for the invitation!
Although I work on the Finite Element Method, the application area covered in this library is outside the scope of my expertise. So, I don't think I am adequately qualified to review this submission.

@chennachaos Understood, thanks!

Dear @kyleniemeyer,
I went through the list and perhaps potential reviewers could be moorepants and jmbr ([email protected]).

Was this page helpful?
0 / 5 - 0 ratings