-
Notifications
You must be signed in to change notification settings - Fork 85
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
docs: Make 'Statement of Need' explicit section in JOSS paper #1290
Conversation
Doesn't really make sense there
Codecov Report
@@ Coverage Diff @@
## master #1290 +/- ##
=======================================
Coverage 97.49% 97.49%
=======================================
Files 63 63
Lines 3749 3749
Branches 535 535
=======================================
Hits 3655 3655
Misses 55 55
Partials 39 39
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
@kratsg @lukasheinrich @cranmer If you can review these changes to the paper:
and approve of the changes, I'll then tag the Editor and Editor in Chief for the review to get their approval that these changes will be acceptable for publication. We can then merge, update the JOSS review Issue, and request review of the paper again. For a reference "Statement of Need" section c.f. the JOSS Example paper and bibliography. |
I put this into Draft mode to help protect it from getting merged until after we get Editor okays, but it is ready for review now. |
The source code for `pyhf` has been archived on Zenodo with the linked DOI: [@pyhf_zenodo]. | ||
At the time of writing this paper, the most recent release of `pyhf` is [`v0.5.4`](https://doi.org/10.5281/zenodo.4318533). | ||
|
||
# Statement of Need | ||
|
||
Through adoption of open source "tensor" computational Python libraries, `pyhf` decreases the abstractions between a physicist performing an analysis and the statistical modeling without sacrificing computational speed. | ||
By taking advantage of tensor calculations, `pyhf` outperforms the traditional `C++` implementation of `HistFactory` on data from real LHC analyses. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would start with the need for a pure python version that is independent of ROOT. Then mention it's faster. And say that yaml aids in likelihood publishing. Not totally sure what "decreases the abstractions between ..." means here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
well, I wrote this a while ago, but didn't click "submit review". Paper is published! So ignore.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I think we got stuck between vague requirements and having the JOSS take a while in this case. It is a fair balance to just repurpose existing text -- but your point is noted. I doubt we can make that phrasing change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry this didn't get posted in time, but thanks for still adding this comment though! Still good to have for the future (as more JOSS papers will come from IRIS-HEP and Scikit-HEP).
Description
As requested by the JOSS Editor in Chief for the review openjournals/joss-reviews#2823, add a section for "Statement of Need". Additionally, move the information on the archival of the
pyhf
source code on Zenodo and the version used in the review out of "Statement of Need" and (back into) the end of "Summary" as this information doesn't belong with motivational text.For posterity, related PRs to the JOSS paper revision are:
Checklist Before Requesting Reviewer
Before Merging
For the PR Assignees: