Joss paper

[antonio-leblanc]

@filippi i did some work on joss branch

Current Status for JOSS Submission:

• Repo Structure: Good (Code, License, CONTRIBUTING.md, CODE_OF_CONDUCT.md, paper/ dir with paper.md/.bib templates, CITATION.cff template). Init Joss preparation #76 #77
• Documentation: Comprehensive structure and content. "Statement of Need" draft added.
• Paper: paper.md/.bib structured, requires content (Summary, Statement of Need, Refs).
• Testing: JOSS requires evidence of working automated tests.** [CI/TESTS] Automated tests #79

Immediate Next Steps (Priority Order):

1. Fix Functional Tests: Modify test comparison scripts (run.bash or similar) to use tolerance-based comparison for floating-point numbers (e.g., awk, numpy.allclose).
2. Enable Tests in CI: Uncomment test execution steps in .github/workflows/main.yml after tests are robust. Ensure they pass in CI.
3. Document Testing: Add a brief section to docs or CONTRIBUTING.md explaining the test strategy (including tolerance).
4. Write Paper Content: Populate paper/paper.md (Summary, Statement of Need, Ack) and paper/paper.bib (references). (Lead: J-B Filippi)
5. Refine Docs: Finalize "Statement of Need" content; check/fix all links (esp. ReadTheDocs URL firefront (antonio's fork) vs forefire (can be used as main url).
6. Final Checks: Fill TODOs in CITATION.cff, review repo/docs/paper before submission.

[antonio-leblanc]

@filippi as dicussed today, the current status

STEPS COMPLETED ✅

• Fix Functional Tests and enable them in CI
• Creating TESTING.md and referencing in the docs..
• fixing read the docs url -> forefire.readthedocs

REMAINS 🎯

1. Write Paper Content
   • Populate paper/paper.md (Summary, Statement of Need, etc) and paper/paper.bib (references). (Lead: J-B Filippi)
2. Merge dev into master
3. Create Tagged Release
   • e.g. e.g., v2.1.0-joss or simply v2.1.0

[antonio-leblanc]

test compilation command

docker run --rm     --volume $PWD/paper:/data     --user $(id -u):$(id -g)     --env JOURNAL=joss     openjournals/inara

[antonio-leblanc]

@filippi I've checked all our materials against the JOSS submission guidelines, and ForeFire is looking extremely well-prepared.

Paper (paper.md) - Minor Refinements (not mandatory)

• Summary Opening : JOSS requests "Important: Begin your paper with a summary of the high-level functionality of your software for a non-specialist reader. Avoid jargon in this section."
  Suggestion: If you find it relevant we could slightly soften the first 1-2 sentences of the "Summary" to make it more broadly accessible before diving into the excellent technical details. For example:
  "Wildfires pose a growing global threat, making accurate prediction of their spread crucial for safety and environmental management. ForeFire is an open-source software package that addresses this challenge by providing a modular, high-performance simulation engine..." (Then flow into the existing detailed summary).

• Update submission date

[antonio-leblanc]

I am splitting this in 2 issues for better clarity.
This issue can be finalized once paper.md is finished

and we can have a new issue fore generating the release and defining the versionning strategy from now on

[antonio-leblanc]

9c1fe33

[antonio-leblanc]

filippi emailed
"Un robot va maintenant se charger de notre soumission, ça va se trouver là :
https://github.com/openjournals/joss-reviews/issues

Hello there, thanks for your submission to JOSS.
Your paper, 'ForeFire: A Modular, Scriptable C++ Simulation Engine and Library for Wildland-Fire Spread ', is currently awaiting triage by our managing editor. This generally takes up to a week, but during busy times can take a number of weeks. Until then, your paper won't show up in the https://github.com/openjournals/joss-reviews repository."

[antonio-leblanc]

referencing to check the status
openjournals/joss-reviews#8423