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]: Python Sorted Containers #1223

Open
whedon opened this Issue Jan 31, 2019 · 7 comments

Comments

Projects
None yet
4 participants
@whedon
Copy link
Collaborator

whedon commented Jan 31, 2019

Submitting author: @grantjenks (Grant Jenks)
Repository: https://github.com/grantjenks/python-sortedcontainers
Version: v2.1.0
Editor: Pending
Reviewer: Pending

Author instructions

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

@grantjenks 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 whedon added the pre-review label Jan 31, 2019

@whedon

This comment has been minimized.

Copy link
Collaborator

whedon commented Jan 31, 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

This comment has been minimized.

Copy link
Collaborator

whedon commented Jan 31, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator

whedon commented Jan 31, 2019

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

/app/vendor/ruby-2.4.4/lib/ruby/2.4.0/find.rb:43:in block in find': No such file or directory - tmp/1223 (Errno::ENOENT) from /app/vendor/ruby-2.4.4/lib/ruby/2.4.0/find.rb:43:in collect!'
from /app/vendor/ruby-2.4.4/lib/ruby/2.4.0/find.rb:43:in find' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-c5f29247288e/lib/whedon/processor.rb:57:in find_paper_paths'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-c5f29247288e/bin/whedon:47: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

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Jan 31, 2019

This software looks useful, even though there's a problem compiling the paper. You can make changes to the source, then enter @whedon compile pdf as a new comment here to try to fix it.

Another issue I have is that it's not clear to me that this is research software according to the JOSS guidelines:

JOSS publishes articles about research software. This definition includes software that: solves complex modeling problems in a scientific context (physics, mathematics, biology, medicine, social science, neuroscience, engineering); supports the functioning of research instruments or the execution of research experiments; extracts knowledge from large data sets; offers a mathematical library, or similar.

Can you help me understand this?

@grantjenks

This comment has been minimized.

Copy link

grantjenks commented Feb 2, 2019

Regarding the guidelines, I think it fits under:

supports the functioning of research instruments or the execution of research experiments

But I may be wrong. I had JOSS suggested to me by the creator of IPython. And I received a GitHub Issue asking how to cite the project. Consider some of the users:

  • Zipline, an algorithmic trading library from Quantopian
  • Angr, a binary analysis platform from UC Santa Barbara
  • Trio, an async I/O library
  • Dask Distributed, a distributed computation library supported by Continuum Analytics
  • Astropy, a community Python library for astronomy

Does that satisfy?

Also, I looked through GitHub issues trying to understand how the PDF is generated:

But I was unable to reproduce the problem. (Maybe those links will be useful for a future visitor). There seems to be a "paper.md" file that is missing. Is that something I generate? I'm happy to accommodate, just not sure what's necessary. I could see how the project README may not be as useful for a paper as say the Performance Comparison, Implementation Details, or Performance at Scale materials.

@arfon

This comment has been minimized.

Copy link
Member

arfon commented Feb 3, 2019

Hi @grantjenks - please take a look at the submission guidelines and prepare a paper.md and paper.bib file and include them in your repository (https://github.com/grantjenks/python-sortedcontainers). Once you've uploaded them, Whedon (the robot here) will be able to compile the paper.

In your paper, please be sure to address each of the points listed in the section what should my paper contain?.

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Feb 3, 2019

Regarding the research application, the problem is that your package is not used by end users for research, but according to your comment, is used by other libraries and packages, some of which then are used for research. I think that's fine, but want to hear from @arfon before we go on.

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