first draft for a potential JOSS paper

Saransh-cpp commented 4 weeks ago

Description

The draft PDF can be downloaded from - https://github.com/scikit-hep/vector/actions/runs/10420364323

JOSS paper format - https://joss.readthedocs.io/en/latest/paper.html JOSS submission guidelines - https://joss.readthedocs.io/en/latest/submitting.html

Checklist

[ ] Have you followed the guidelines in our Contributing document?
[ ] Have you checked to ensure there aren't any other open Pull Requests for the required change?
[ ] Does your submission pass pre-commit? ($ pre-commit run --all-files or $ nox -s lint)
[ ] Does your submission pass tests? ($ pytest or $ nox -s tests)
[ ] Does the documentation build with your changes? ($ cd docs; make clean; make html or $ nox -s docs)
[ ] Does your submission pass the doctests? ($ pytest --doctest-plus src/vector/ or $ nox -s doctests)

Before Merging

[ ] Summarize the commit messages into a brief review of the Pull request.

codecov[bot] commented 4 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 86.85%. Comparing base (13a6370) to head (c66629a).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #496 +/- ## ======================================= Coverage 86.85% 86.85% ======================================= Files 96 96 Lines 11919 11919 ======================================= Hits 10352 10352 Misses 1567 1567 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

Saransh-cpp commented 1 week ago

Thanks for the reviews, @jpivarski and @henryiii! I have made corrections, but could you please review it again whenever you get the time?

Are you sure you want to write the paper in the Vector repo itself, rather than as a separate repo just for the paper? How is it normally done?

The JOSS submission guidelines say -

Your paper (paper.md and BibTeX files, plus any figures) must be hosted in a Git-based repository together with your software.

The paper may be in a short-lived branch which is never merged with the default, although if you do this, make sure this branch is created from the default so that it also includes the source code of your submission.

I will prefer not merging this in and just using this PR to review the content. Once everything is reviewed, I will submit the paper from the short-lived branch and delete the branch once the paper is published

scikit-hep / vector