[PRE REVIEW]: py-opc: operate the Alphasense OPC-N2 from a raspberry pi or other popular microcontrollers/microcomputers

whedon commented 6 years ago

Submitting author: @dhhagan (David Henry Hagan) Repository: https://github.com/dhhagan/py-opc Version: 1.4.1 Editor: @Kevin-Mattheus-Moerman Reviewers: @tshu

Author instructions

Thanks for submitting your paper to JOSS @dhhagan. 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.

@dhhagan 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 commented 6 years ago

Hello human, I'm @whedon. I'm here to help you with some common editorial tasks.

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

@whedon commands

whedon commented 6 years ago

Attempting PDF compilation. Reticulating splines etc...

whedon commented 6 years ago

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

 /app/vendor/ruby-2.3.4/lib/ruby/2.3.0/psych.rb:379:in `parse': (tmp/540/paper/paper.md): mapping values are not allowed in this context at line 2 column 7 (Psych::SyntaxError)
    from /app/vendor/ruby-2.3.4/lib/ruby/2.3.0/psych.rb:379:in `parse_stream'
    from /app/vendor/ruby-2.3.4/lib/ruby/2.3.0/psych.rb:327:in `parse'
    from /app/vendor/ruby-2.3.4/lib/ruby/2.3.0/psych.rb:254:in `load'
    from /app/vendor/ruby-2.3.4/lib/ruby/2.3.0/psych.rb:475:in `block in load_file'
    from /app/vendor/ruby-2.3.4/lib/ruby/2.3.0/psych.rb:474:in `open'
    from /app/vendor/ruby-2.3.4/lib/ruby/2.3.0/psych.rb:474:in `load_file'
    from /app/vendor/bundle/ruby/2.3.0/bundler/gems/whedon-8307502c3aee/lib/whedon.rb:73:in `initialize'
    from /app/vendor/bundle/ruby/2.3.0/bundler/gems/whedon-8307502c3aee/lib/whedon/processor.rb:26:in `new'
    from /app/vendor/bundle/ruby/2.3.0/bundler/gems/whedon-8307502c3aee/lib/whedon/processor.rb:26:in `set_paper'
    from /app/vendor/bundle/ruby/2.3.0/bundler/gems/whedon-8307502c3aee/bin/whedon:37:in `prepare'
    from /app/vendor/bundle/ruby/2.3.0/gems/thor-0.20.0/lib/thor/command.rb:27:in `run'
    from /app/vendor/bundle/ruby/2.3.0/gems/thor-0.20.0/lib/thor/invocation.rb:126:in `invoke_command'
    from /app/vendor/bundle/ruby/2.3.0/gems/thor-0.20.0/lib/thor.rb:387:in `dispatch'
    from /app/vendor/bundle/ruby/2.3.0/gems/thor-0.20.0/lib/thor/base.rb:466:in `start'
    from /app/vendor/bundle/ruby/2.3.0/bundler/gems/whedon-8307502c3aee/bin/whedon:99:in `<top (required)>'
    from /app/vendor/bundle/ruby/2.3.0/bin/whedon:22:in `load'
    from /app/vendor/bundle/ruby/2.3.0/bin/whedon:22:in `<main>'

arfon commented 6 years ago

👋 @dhhagan - thanks for your submission to JOSS. It looks like the paper.md YAML header is a little off - this PR should fix it: https://github.com/dhhagan/py-opc/pull/54/

From a quick inspection of this submission it's not entirely obvious that it meets our submission criteria. In particular, this item:

Your software should have an obvious research application

Could you confirm here that there is a research application for this software (and explain what that application is)? The section 'what should my paper contain' has some guidance for the sort of content we're looking to be present in the paper.md.

Many thanks!

dhhagan commented 6 years ago

Hey @arfon , thanks for the PR (now merged). The research purpose is that it allows researchers to operate the particle counter from any microcontroller, rather than a PC, and is used by many research organizations (EPA, UNEP, MIT, Leeds, etc) to do aerosol research. Maybe a bit more information is given in a pre-submission inquiry I posted last month (https://github.com/openjournals/joss/issues/362).

Let me know if this doesn't fit and I can withdraw.

arfon commented 6 years ago

@whedon generate pdf

whedon commented 6 years ago

Attempting PDF compilation. Reticulating splines etc...

whedon commented 6 years ago

https://github.com/openjournals/joss-papers/blob/joss.00540/joss.00540/10.21105.joss.00540.pdf

arfon commented 6 years ago

Hey @arfon , thanks for the PR (now merged). The research purpose is that it allows researchers to operate the particle counter from any microcontroller, rather than a PC, and is used by many research organizations (EPA, UNEP, MIT, Leeds, etc) to do aerosol research. Maybe a bit more information is given in a pre-submission inquiry I posted last month (openjournals/joss#362).

Thanks @dhhagan - I'd forgotten that you'd already enquired. We should be able to proceed here.

While we wait for an editor to volunteer (and then find a reviewer) would you mind fleshing out your paper with a little more detail? Our goal is to have short papers that are understandable by a non-specialist audience. Right now I don't think this paper is quite there.

dhhagan commented 6 years ago

Okay. I gave a rewrite a stab. I read a bunch of the accepted papers and tried to model it based on those, so hopefully it is okay now.