Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
whedon opened this issue Jan 19, 2018 · 34 comments

Comments

@whedon
Copy link

whedon commented Jan 19, 2018

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
Copy link
Author

whedon commented Jan 19, 2018

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
Copy link
Author

whedon commented Jan 19, 2018

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Jan 19, 2018

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
Copy link
Member

arfon commented Jan 19, 2018

👋 @dhhagan - thanks for your submission to JOSS. It looks like the paper.md YAML header is a little off - this PR should fix it: dhhagan/py-opc#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
Copy link

dhhagan commented Jan 19, 2018

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).

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

@arfon
Copy link
Member

arfon commented Jan 20, 2018

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jan 20, 2018

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Jan 20, 2018

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

@arfon
Copy link
Member

arfon commented Jan 20, 2018

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
Copy link

dhhagan commented Jan 24, 2018

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.

@Kevin-Mattheus-Moerman
Copy link
Member

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jan 26, 2018

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Jan 26, 2018

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

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Jan 26, 2018

👋 @rajeshxsankaran @jared711 @skgrange would you be interested in reviewing this project for the Journal of Open Source Software, the review process focuses largely on the software and a short paper. Let me know if you are available to help so I can open a review issue for this submission.

@Kevin-Mattheus-Moerman
Copy link
Member

@whedon assign @Kevin-Mattheus-Moerman as editor

@whedon
Copy link
Author

whedon commented Jan 26, 2018

OK, the editor is @Kevin-Mattheus-Moerman

@Kevin-Mattheus-Moerman
Copy link
Member

@dhhagan thanks for submitting this paper to JOSS. I've started looking for reviewers. If you could suggest suitable reviewers that would be very helpful. Also your work appears to rely on hardware. Will reviewers require this hardware for review? Can some aspects of the code be reviewed without the hardware?

@dhhagan
Copy link

dhhagan commented Jan 26, 2018

Hey @Kevin-Mattheus-Moerman: it does rely on hardware - I guess it depends on exactly what the review entails, but it would probably work better with the hardware. I suppose, depending on where the reviewers are located, I could lend a unit for review? What has been done in the past with code that relies on hardware?

@Kevin-Mattheus-Moerman
Copy link
Member

@amjaeger17 could you help review this please if @dhhagan drops off the device at the Media Lab?

@amjaeger17
Copy link

@Kevin-Mattheus-Moerman I can look at this next week if you have not found anyone else yet.

@Kevin-Mattheus-Moerman
Copy link
Member

@dhhagan could you drop off the device at the MIT Media Lab ​E14-274G (my office)? I'll then pass it on to @amjaeger17 who can help with review.

@dhhagan
Copy link

dhhagan commented Mar 1, 2018 via email

@Kevin-Mattheus-Moerman
Copy link
Member

We should have lots of pi's but bring yours if you think it is different.

@dhhagan
Copy link

dhhagan commented Mar 3, 2018

Perfect. @Kevin-Mattheus-Moerman I'll drop it off Monday mid-morning.

@Kevin-Mattheus-Moerman
Copy link
Member

@amjaeger17 Could you please give us an estimated timeline for your review to be completed? Thanks

@dhhagan
Copy link

dhhagan commented Apr 10, 2018

Hey @Kevin-Mattheus-Moerman Anything I can do to speed this along?

@dhhagan
Copy link

dhhagan commented May 7, 2018

Hey @Kevin-Mattheus-Moerman I dropped off the device with you, right? Could I come and grab it sometime this week - it needs to go out into the field soon. Thanks!

@Kevin-Mattheus-Moerman
Copy link
Member

Yes you can. Does Friday work?

@arfon
Copy link
Member

arfon commented Jun 15, 2018

👋 how are we doing here?

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Jun 15, 2018

The device is still here at the MIT media lab. My colleague @amjaeger17 can unfortunately no longer do this review. I will ask another colleague to take a look but if he cannot then perhaps we are at a dead end for now. Apologies for the delay this has caused with this submission.

@Kevin-Mattheus-Moerman
Copy link
Member

@whedon assign @tshu as reviewer

@whedon
Copy link
Author

whedon commented Jun 18, 2018

OK, the reviewer is @tshu

@Kevin-Mattheus-Moerman
Copy link
Member

@whedon start review magic-word=bananas

@whedon
Copy link
Author

whedon commented Jun 18, 2018

OK, I've started the review over in #782. Feel free to close this issue now!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants