JOSS paper

[wtbarnes]

NOTE: Merge this into its own branch joss on the upstream repository, not main.

• Full draft of paper
• Edit for length and clarity
• Send out to GH/code authors
• Send out to full author list
• Address comments as needed
• Delete PDF draft Action
• Merge into joss branch upstream
• Submit

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.92%. Comparing base (90e9c5a) to head (308600f).
⚠️ Report is 1 commits behind head on joss.

Additional details and impacted files

@@           Coverage Diff           @@
##             joss     #127   +/-   ##
=======================================
  Coverage   81.92%   81.92%           
=======================================
  Files          11       11           
  Lines         354      354           
=======================================
  Hits          290      290           
  Misses         64       64           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[wtbarnes]

@jwreep @nabobalis @schonfsj @sjbradshaw I've written up a draft of a short Journal of Open-Source Software (JOSS) paper describing the ebtelplusplus code and have included you all as authors. Have a look at the draft here (https://github.com/rice-solar-physics/ebtelplusplus/actions/runs/18738966835/artifacts/4348289863) and/or let me know if you'd like to be included as a co-author. I added you all as you've made contributions either to this code or the EBTEL model as a whole. Once we've done a pass over it here, I'll pass it on to the remaining coauthors.

For those of you who haven't participated in a JOSS paper before, the idea is to write a very short paper (<1000 words) with the bulk of the review focused on the software itself. If you're interested you can read more about it here: https://joss.readthedocs.io/en/latest/index.html. The reviews are typically very straightforward and take place publicly on GitHub.

You may be asking "why in the world are we writing yet another EBTEL paper?" which is a completely valid question. The reason I wrote this up is because there is no reference that includes the modified equations for the two-fluid, area expansion, and variable abundance, all of which this code now includes. As such it is a reference primarily for the software but also for this form of the equations.

[nabobalis]

Happy to be involved.

[sjbradshaw]

Sounds like a good idea. Handy to have a reference, anyhow, rather than adding the Github address as a footnote.

[jwreep]

Thanks for putting this together, Will! I'll review the paper soon and get back to with comments/suggestions. Would you prefer comments on Github or on a PDF?

[wtbarnes]

Would you prefer comments on Github or on a PDF?

If you want to just make suggestions inline in the Markdown file that'd be great!

My plan is to iterate on the text on this branch as people have comments, merge it, and then submit.

[schonfsj]

@wtbarnes, this is great! Thanks so much for including me.

I added an inline comment, but I'm still fairly novice with GitHub collaboration, so apologies if it's not quite in the right place/format/etc.

[wtbarnes]

Thanks for the feedback all! I'm going to send this around to the remaining coauthors and continue to make corrections here as needed.