Prepare JOSS submission artifacts

[KedoKudo]

Parent Epic

Part of JOSS Publication Epic

Description

Prepare all required artifacts for JOSS submission.

Required Files

1. paper.md

• Main paper content (see draft issue)

2. paper.bib

• BibTeX bibliography
• Include SAMMY, ENDF, and relevant software papers

3. CITATION.cff

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: [LastName]
    given-names: Alex
    orcid: https://orcid.org/0000-0000-0000-0000
  - family-names: Zhang
    given-names: Chen
    orcid: https://orcid.org/0000-0000-0000-0000
  - family-names: [LastName]
    given-names: Jean
    orcid: https://orcid.org/0000-0000-0000-0000
title: "PLEIADES: Python Libraries Extensions for Isotopic Analysis via Detailed Examination of SAMMY"
version: 2.0.0
doi: 10.5281/zenodo.12729688
date-released: 2025-10-03
url: "https://github.com/lanl/PLEIADES"

4. Repository Checklist

• Clear README with installation instructions
• License file (BSD-3) ✅
• Contributing guidelines
• Code of conduct
• Tests passing ✅
• Documentation deployed ✅

5. Zenodo Archive

• Create new Zenodo release
• Update DOI in CITATION.cff
• Link Zenodo to GitHub

Tasks

• Create/update CITATION.cff
• Create paper.bib with references
• Add CONTRIBUTING.md if missing
• Add CODE_OF_CONDUCT.md if missing
• Create Zenodo release for submission version
• Verify all JOSS checklist items

Pre-Submission Checklist

From JOSS guidelines:

• Software is open source
• Software is hosted on GitHub/GitLab
• Software has a clear README
• Software has documentation
• Software has tests
• Authors have ORCIDs
• Paper follows JOSS format

Assignee

@along4 (with help from @KedoKudo for technical items)

[along4]

Hey @KedoKudo, where should the CITATION.cff file be in the repo. Should it be in the top level directory on in the paper dir?

[along4]

Created new Zenodo release https://zenodo.org/records/17782275

[KedoKudo]

Hey @KedoKudo, where should the CITATION.cff file be in the repo. Should it be in the top level directory on in the paper dir?

It should be in the paper folder (see example: https://github.com/AlbanBloorRiley/INS_IEP/tree/main/Paper)