JOSS Paper

[tamasgal]

@Moelf and @aminnj I'd like to invite you to collaborate on a short (a few pages) JOSS paper, so that we get a DOI which is citable. The purpose of this publication is to introduce UnROOT to the world, outline the reason of its existence, show some short usage examples and compare it with existing other solution. No more, no less ;)

Let me know if you are interested. I already added both of you to the template since we three are now definitely the main devs and the core team!

Feel free to dump ideas and add your affiliations (and @aminnj add your ORCID) if you're in.

[codecov]

Codecov Report

Merging #135 (d880c7f) into master (dbeca02) will decrease coverage by 0.09%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #135      +/-   ##
==========================================
- Coverage   92.32%   92.23%   -0.10%     
==========================================
  Files          11       10       -1     
  Lines        1447     1442       -5     
==========================================
- Hits         1336     1330       -6     
- Misses        111      112       +1     

Impacted Files	Coverage Δ
src/iteration.jl	88.76% <0.00%> (-0.51%)	⬇️
src/UnROOT.jl	100.00% <0.00%> (ø)
src/polyester.jl

---

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 dbeca02...d880c7f. Read the comment docs.

[Moelf]

a few examples to show what content and length to expect:
https://joss.theoj.org/papers/10.21105/joss.00602
https://joss.theoj.org/papers/10.21105/joss.02673
https://joss.theoj.org/papers/10.21105/joss.03349
https://joss.theoj.org/papers/10.21105/joss.01816

[aminnj]

Thanks! Happy to contribute. Should we use something like overleaf before pushing it back into the repo?

[tamasgal]

Nice!

JOSS requires a simple markdown and renders the PDF for us, so we can stay with that, if you agree, but we can look for a collaborative editing tool for markdown, I guess that's a good idea anyways.

[tamasgal]

For the last JOSS paper we used hackmd.io but I have no premium account and it seems they limited some features since then ;) However, three people can still work together, so that might be an option. Or do you have an other suggestion?

[aminnj]

Ah didn’t know that. Markdown is pretty wysiwyg so we can always use a shared google doc :)

[tamasgal]

Alright, I invited you to a shared Google doc, I guess that should do it ;)

Edit: JOSS requires the paper to sit in the repository, so we can sync it back when we are done with the first draft.

This is the preview service: https://whedon.theoj.org

I added a GitHub action for the PDF preview.

[Moelf]

(we probably wanna disable CI, not sure how)

Putting up a list of things to cite (at least mention & compare)

• Julia language
• ROOT's string programming
• uproot, especially AK array now that it's C++ glue again
• fractured RVec, RDataFrame, TTree bind, TTreeReader
• gohep/root (didn't take off because base language isn't popular for technical computing)
• https://arxiv.org/abs/2003.11952

[aminnj]

CI fails because the table drawing characters don't exist for the font. When I tried https://whedon.theoj.org/, it just stripped out those characters entirely but still compiled:
link
Doesn't look bad, actually. I'll remove them from the md so that our CI works.

EDIT: CI works but paper/paper.pdf must've gone into a black hole since I don't see it anywhere. Oh well...

[tamasgal]

Damn tables 😆 maybe we find a working example out there...

[codecov]

Codecov Report

Merging #135 (d4400d0) into master (e374cd8) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #135   +/-   ##
=======================================
  Coverage   90.14%   90.14%           
=======================================
  Files          11       11           
  Lines        1604     1604           
=======================================
  Hits         1446     1446           
  Misses        158      158           

---

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 e374cd8...d4400d0. Read the comment docs.

[Moelf]

is this ready to go?

[tamasgal]

@Moelf and @aminnj can you have a look? I think it's more or less ready to go. There are probably still a few typos though 😅 Just edit as you like and if once everyone here agrees, I'll go ahead and submit it.

(@Moelf I combined the changes and additions in your last commit and then also rebased and force pushed.)

[tamasgal]

OK, Jerry approved, if @aminnj is fine with it, I'll go ahead with the review request 🙂

[tamasgal]

cg39hcpdd16nasx2zn2c.pdf