[PRE REVIEW]: dfitspy #1217

whedon · Jan 29, 2019

Submitting author: @astrom-tom (Romain Thomas)
Repository: https://github.com/astrom-tom/dfitspy
Version: v19.1.5
Editor: Pending
Reviewer: Pending

Author instructions

Thanks for submitting your paper to JOSS @astrom-tom. The JOSS editor Pending, will work with you on this issue to find a reviewer for your submission before creating the main review issue.

@astrom-tom 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 · Jan 29, 2019

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 😸

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 · Jan 29, 2019

Attempting PDF compilation. Reticulating splines etc...

whedon · Jan 29, 2019

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

/app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-c5f29247288e/lib/whedon.rb:83:in check_fields': Paper YAML header is missing expected fields: bibliography (RuntimeError) from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-c5f29247288e/lib/whedon.rb:69:in initialize'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-c5f29247288e/lib/whedon/processor.rb:32:in new' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-c5f29247288e/lib/whedon/processor.rb:32:in set_paper'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-c5f29247288e/bin/whedon:52:in prepare' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/command.rb:27:in run'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/invocation.rb:126:in invoke_command' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor.rb:387:in dispatch'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/base.rb:466:in start' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-c5f29247288e/bin/whedon:113:in <top (required)>'
from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in load' from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in

'

danielskatz · Jan 29, 2019

@astrom-tom - I don't see any .bib file in your repo, and your reference is written manually, rather than being compiled. Please refer to https://joss.readthedocs.io/en/latest/submitting.html#example-paper-and-bibliography for an example. Once you've made changes in your repository, enter @whedon generate pdf as a new comment here to attempt to rebuild the pdf from the md and bib files.

danielskatz · Jan 29, 2019

You also need some real content in the readme, including the purpose of the software, what problems it can solve, a pointer to how it can be installed and tested, how others can contribute, etc.

See https://joss.readthedocs.io/en/latest/review_criteria.html, which states:

A high-level overview of this documentation should be included in a README file (or equivalent).

danielskatz · Jan 29, 2019

Also, I see a bunch of temporary files inside the repository that you might want to remove - those that end with ~

danielskatz · Jan 29, 2019

Once these changes are made, let me know and we'll move forward to assigning an editor

astrom-tom · Jan 31, 2019

@whedon generate pdf

whedon · Jan 31, 2019

Attempting PDF compilation. Reticulating splines etc...

whedon · Jan 31, 2019

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

/app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-c5f29247288e/lib/whedon.rb:83:in check_fields': Paper YAML header is missing expected fields: bibliography (RuntimeError) from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-c5f29247288e/lib/whedon.rb:69:in initialize'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-c5f29247288e/lib/whedon/processor.rb:32:in new' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-c5f29247288e/lib/whedon/processor.rb:32:in set_paper'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-c5f29247288e/bin/whedon:52:in prepare' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/command.rb:27:in run'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/invocation.rb:126:in invoke_command' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor.rb:387:in dispatch'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/base.rb:466:in start' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-c5f29247288e/bin/whedon:113:in <top (required)>'
from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in load' from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in

'

astrom-tom · Jan 31, 2019

@whedon generate pdf

whedon · Jan 31, 2019

Attempting PDF compilation. Reticulating splines etc...

whedon · Jan 31, 2019

👉 Check article proof 📄 👈

astrom-tom · Jan 31, 2019

@whedon generate pdf

whedon · Jan 31, 2019

Attempting PDF compilation. Reticulating splines etc...

whedon · Jan 31, 2019

👉 Check article proof 📄 👈

astrom-tom · Jan 31, 2019

Dear @danielskatz,

Thank you for dealing with my submission. For the readme, there is only one link that goes to github pages (full documentation made with sphinx). Is that enough?

Thanks again!

astrom-tom · Jan 31, 2019

@whedon generate pdf

whedon · Jan 31, 2019

Attempting PDF compilation. Reticulating splines etc...

whedon · Jan 31, 2019

👉 Check article proof 📄 👈

danielskatz · Feb 1, 2019

Thank you for dealing with my submission. For the readme, there is only one link that goes to github pages (full documentation made with sphinx). Is that enough?

No, it's not. This is what I wrote in #1217 (comment)

astrom-tom · Feb 2, 2019

A high-level overview of this documentation should be included in a README file (or equivalent).

What means 'or equivalent'?
In any case, I updated the readme and pointed also to the real online documentation.

danielskatz · Feb 3, 2019

Equivalent is in case the software is not on github and in some other system where the initial file has some other name.

danielskatz · Feb 3, 2019

👋 @arfon - can you edit this submission?

whedon added the pre-review label Jan 29, 2019

whedon added HTML Makefile Python labels Jan 29, 2019

openjournals/joss-reviews

Join GitHub today

[PRE REVIEW]: dfitspy #1217

Comments

whedon commented Jan 29, 2019

whedon added the pre-review label Jan 29, 2019

This comment has been minimized.

whedon commented Jan 29, 2019

This comment has been minimized.

whedon commented Jan 29, 2019

This comment has been minimized.

whedon commented Jan 29, 2019

whedon added HTML Makefile Python labels Jan 29, 2019

This comment has been minimized.

danielskatz commented Jan 29, 2019

This comment has been minimized.

danielskatz commented Jan 29, 2019

This comment has been minimized.

danielskatz commented Jan 29, 2019

This comment has been minimized.

danielskatz commented Jan 29, 2019

This comment has been minimized.

astrom-tom commented Jan 31, 2019

This comment has been minimized.

whedon commented Jan 31, 2019

This comment has been minimized.

whedon commented Jan 31, 2019

This comment has been minimized.

astrom-tom commented Jan 31, 2019

This comment has been minimized.

whedon commented Jan 31, 2019

This comment has been minimized.

whedon commented Jan 31, 2019

This comment has been minimized.

astrom-tom commented Jan 31, 2019

This comment has been minimized.

whedon commented Jan 31, 2019

This comment has been minimized.

whedon commented Jan 31, 2019

This comment has been minimized.

astrom-tom commented Jan 31, 2019 • edited

This comment has been minimized.

astrom-tom commented Jan 31, 2019

This comment has been minimized.

whedon commented Jan 31, 2019

This comment has been minimized.

whedon commented Jan 31, 2019

This comment has been minimized.

danielskatz commented Feb 1, 2019

This comment has been minimized.

astrom-tom commented Feb 2, 2019

This comment has been minimized.

danielskatz commented Feb 3, 2019

This comment has been minimized.

danielskatz commented Feb 3, 2019

astrom-tom commented Jan 31, 2019 •

edited