Skip to content

docs: prepare to submit a paper to JOSS#109

Open
tkoyama010 wants to merge 28 commits intomainfrom
joss-paper
Open

docs: prepare to submit a paper to JOSS#109
tkoyama010 wants to merge 28 commits intomainfrom
joss-paper

Conversation

@tkoyama010
Copy link
Copy Markdown
Owner

@tkoyama010 tkoyama010 commented Mar 11, 2026

Summary

  • Add joss/paper.md with a draft paper for submission to the Journal of Open Source Software
  • Add joss/paper.bib with references for PyVista, vtk.js, VTK, NumPy, JupyterLite, and Jupyter
  • Add .github/workflows/ci-draft-pdf.yml to build and upload a draft PDF on every push

Resolve #63

Test plan

  • Verify ci-draft-pdf workflow builds the PDF without errors
  • Review paper content and update author/affiliation details
  • Also update CITATION.cff

tkoyama010 and others added 2 commits March 11, 2026 23:10
Resolves #63

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 11, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://tkoyama010.github.io/pyvista-js/pr-preview/pr-109/

Built to branch gh-pages at 2026-03-18 13:18 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

pre-commit-ci bot and others added 7 commits March 11, 2026 14:13
The normalize-metadata.lua filter in inara requires affiliation to be a
string ("1") not an integer (1) to correctly look up affiliations by index.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
mdformat was reformatting paper.md, converting YAML frontmatter `---`
delimiters to horizontal rules and breaking indentation, which caused
normalize-metadata.lua to fail with a nil authors error.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@tkoyama010 tkoyama010 requested a review from Copilot March 11, 2026 15:09
@tkoyama010 tkoyama010 marked this pull request as ready for review March 11, 2026 15:09
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR prepares the repository for a JOSS submission by adding the draft paper + bibliography and introducing CI to build a draft PDF artifact on pushes.

Changes:

  • Add joss/paper.md (draft JOSS paper) and joss/paper.bib (references).
  • Add a GitHub Actions workflow to build and upload a draft PDF on each push.
  • Update pre-commit configuration to exclude the joss/ directory from mdformat.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
joss/paper.md Introduces the JOSS paper draft (front matter + Summary/Statement of need).
joss/paper.bib Adds BibTeX entries for cited projects/publications used by the paper.
.pre-commit-config.yaml Prevents mdformat from reformatting the JOSS paper directory.
.github/workflows/ci-draft-pdf.yml Builds the JOSS draft PDF and uploads it as a CI artifact.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment thread .github/workflows/ci-draft-pdf.yml Outdated
Comment thread joss/paper.bib Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Comment thread .github/workflows/ci-draft-pdf.yml Outdated
Comment thread joss/paper.md Outdated
tkoyama010 and others added 11 commits March 12, 2026 17:50
Co-authored-by: Tetsuo Koyama <tkoyama010@gmail.com>
- Pin actions/checkout, openjournals-draft-action, and
  actions/upload-artifact to full commit SHAs
- Add persist-credentials: false to checkout step
- Add minimal permissions block at workflow and job level

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Use the official VTK citation from book.vtk.org with ISBN and
canonical title.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace GitHub repository reference with the Zenodo DOI citation
(10.5281/zenodo.10962631) for vtk.js v30.4.0.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Use the official Pyodide Zenodo citation (10.5281/zenodo.5156931)
and update paper text to reference Pyodide instead of JupyterLite
and Jupyter.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace 'and others' with the full author list from the Zenodo
record (10.5281/zenodo.10962631).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@tkoyama010 tkoyama010 changed the title Prepare to submit a paper to JOSS docs: prepare to submit a paper to JOSS Mar 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

JOSS Paper Submission

2 participants