Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add JOSS paper #41

Merged
merged 51 commits into from
Oct 31, 2023
Merged

docs: Add JOSS paper #41

merged 51 commits into from
Oct 31, 2023

Conversation

rkansal47
Copy link
Member

@rkansal47 rkansal47 commented Aug 18, 2023

Description

Add paper.md and paper.bib as needed for a JOSS paper submission.
Also adds the Open Journals Github Action to compile the paper.

Action Item Checklist

  • Write paper
  • Check it compiles
  • Review
  • Submit to JOSS

Paper checklist

  • A list of the authors of the software and their affiliations, using the correct format.
  • A summary describing the high-level functionality and purpose of the software for a diverse, non-specialist audience.
  • A clear Statement of Need that illustrates the research purpose of the software.
  • A list of key references, including to other software addressing related needs.
  • Mention (if applicable) a representative set of past or ongoing research projects using the software and recent scholarly publications enabled by it.
  • Acknowledgement of any financial support.

@rkansal47 rkansal47 added the documentation Improvements or additions to documentation label Aug 18, 2023
@rkansal47 rkansal47 self-assigned this Aug 18, 2023
@rkansal47 rkansal47 marked this pull request as draft August 18, 2023 15:53
@jmduarte jmduarte marked this pull request as ready for review October 30, 2023 20:33
@jmduarte
Copy link
Member

jmduarte commented Oct 30, 2023

We should also add the NeurIPS paper to CITATION.cff as a "reference" I guess.

.github/workflows/JOSS-pdf.yml Outdated Show resolved Hide resolved
.github/workflows/JOSS-pdf.yml Outdated Show resolved Hide resolved
@jmduarte jmduarte merged commit e865226 into main Oct 31, 2023
24 checks passed
@jmduarte jmduarte deleted the JOSS-2023 branch October 31, 2023 01:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants