Skip to content

Commit

Permalink
add joss paper workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
alchem0x2A committed Sep 28, 2024
1 parent 6a77f19 commit 748bd53
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 2 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/joss_paper.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Draft Paper for JOSS
on:
push:
paths:
- paper/**
- .github/workflows/joss_paper.yml

jobs:
paper:
runs-on: ubuntu-latest
name: Paper Draft
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build draft PDF
uses: openjournals/openjournals-draft-action@master
with:
journal: joss
paper-path: paper/paper.md
- name: Upload
uses: actions/upload-artifact@v4
with:
name: paper
path: paper/paper.pdf
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -784,3 +784,5 @@ examples/ex1-ase/
/test-2/
*.pt
/README.html
/paper/paper.pdf
/paper/jats/
15 changes: 13 additions & 2 deletions paper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,19 @@ SPARC doc in this directory.

## Using Building Actions

TBD


## Building Locally

TBD
Follow the instructions in the [JOSS
manual](https://joss.readthedocs.io/en/latest/paper.html#docker), use
docker (or equivalent) to build the paper locally:
```bash
# At the paper/ subfolder of the SPARC-X-API repository
docker run --rm \
--volume $PWD:/data \
--user $(id -u):$(id -g) \
--env JOURNAL=joss \
openjournals/inara
```
This command will create the `paper.pdf` under the `paper/` subfolder.

0 comments on commit 748bd53

Please sign in to comment.