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

add joss paper #482

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

add joss paper #482

wants to merge 9 commits into from

Conversation

maurerle
Copy link
Member

@maurerle maurerle commented Nov 15, 2024

This is the branch for the submission to JOSS.
Our submission will probably be handled here once it is assigned to reviewers:
https://joss.theoj.org/papers/a8843ad1978808dc593b16437a2a029e

create the paper.pdf using
pandoc -s paper.md -o paper.pdf --bibliography paper.bib --citeproc

or officially for joss draft using

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

An published JOSS paper from our friends at AMIRIS can be found here: https://joss.theoj.org/papers/10.21105/joss.05041


Would be great if you could look over and adjust the paper.md and add things you would like to have mentioned in this software publication :)


Note: the submission works just fine with this being on a separate branch, I would just prefer to merge this at the end of the publication process - otherwise we can also let this stay on the paper branch forever.


First draft of the paper can be seen here:
paper.pdf

Copy link

codecov bot commented Nov 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.90%. Comparing base (16cbea2) to head (c3022ad).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #482   +/-   ##
=======================================
  Coverage   75.90%   75.90%           
=======================================
  Files          51       51           
  Lines        6818     6818           
=======================================
  Hits         5175     5175           
  Misses       1643     1643           
Flag Coverage Δ
pytest 75.90% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

create using
pandoc -s paper.md -o paper.pdf --bibliography paper.bib  --citeproc
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
Copy link
Member

@nick-harder nick-harder left a comment

Choose a reason for hiding this comment

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

@maurerle thanks, looks nice, I have left a bunch of comments. maybe it would have been easier to directly work in the text, but I didn't want to overwrite your text

paper/paper.md Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Show resolved Hide resolved
paper/paper.md Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
@nick-harder
Copy link
Member

@maurerle from my side everything looks fine. Maybe we should make a new release before you submit this? @kim-mskw @Manish-Khanra everything looks fine from your side?

@maurerle
Copy link
Member Author

maurerle commented Dec 3, 2024

I initiated the review process in JOSS, but they did not yet assign reviewers.
It is fine to keep the branch here, until we have the final reviewed version.
So we just have to wait here for now :)

@kim-mskw
Copy link
Contributor

kim-mskw commented Dec 4, 2024

looks fine from your side?

I already requested changes which were handled :)

@kim-mskw kim-mskw self-requested a review December 4, 2024 08:31
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.

3 participants