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

docs: Make 'Statement of Need' explicit section in JOSS paper #1290

Merged
merged 5 commits into from
Feb 4, 2021

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Feb 4, 2021

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

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Add 'Statement of Need' section heading to JOSS paper
   - c.f. https://github.com/openjournals/joss-reviews/issues/2823
* Move information on version and Zenodo archive back to 'Summary' section

@matthewfeickert matthewfeickert added the docs Documentation related label Feb 4, 2021
@matthewfeickert matthewfeickert self-assigned this Feb 4, 2021
@codecov
Copy link

codecov bot commented Feb 4, 2021

Codecov Report

Merging #1290 (8840586) into master (f46c862) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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           
Flag Coverage Δ
unittests 97.49% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f46c862...8840586. Read the comment docs.

@matthewfeickert
Copy link
Member Author

matthewfeickert commented Feb 4, 2021

@kratsg @lukasheinrich @cranmer If you can review these changes to the paper:

  1. Go to https://whedon.theoj.org/
  2. Paper repository address: https://github.com/scikit-hep/pyhf/
  3. Custom branch: docs/make-statement-of-need-a-section
  4. Compile

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.

@matthewfeickert matthewfeickert marked this pull request as draft February 4, 2021 09:10
@matthewfeickert
Copy link
Member Author

matthewfeickert commented Feb 4, 2021

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.

kratsg and others added 2 commits February 4, 2021 07:51
@kratsg kratsg marked this pull request as ready for review February 4, 2021 14:46
@kratsg kratsg merged commit 8d4491f into master Feb 4, 2021
@kratsg kratsg deleted the docs/make-statement-of-need-a-section branch February 4, 2021 15:27
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.
Copy link

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.

Copy link

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.

Copy link
Contributor

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.

Copy link
Member Author

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

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

Successfully merging this pull request may close these issues.

3 participants