-
Notifications
You must be signed in to change notification settings - Fork 49
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
Draft for a JOSS paper #328
base: master
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #328 +/- ##
=======================================
Coverage 98.83% 98.83%
=======================================
Files 28 28
Lines 1895 1895
Branches 407 407
=======================================
Hits 1873 1873
Misses 2 2
Partials 20 20 ☔ View full report in Codecov by Sentry. |
Hey @xiki-tempula, thanks for getting this started! How would you like me (and others) to engage? Do you mind if I push directly to this branch as I work on this with you? |
@dotsdl I think you can just commit to the branch. But it would be nice to keep the commit history simple so there won't be a millions of fix typo commit. |
@xiki-tempula understood, thanks. Will do the best I can to avoid commit spam. I think once we're ready to merge we can do it as a squash to avoid adding noise to |
I just wanted to do a status check on this, since I’d been expecting to need to review mid-September…?
Thanks.
…On Aug 22, 2023, 8:17 AM -0700, David L. Dotson ***@***.***>, wrote:
@xiki-tempula understood, thanks. Will do the best I can to avoid commit spam. I think once we're ready to merge we can do it as a squash to avoid adding noise to master.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because your review was requested.Message ID: ***@***.***>
|
@dotsdl Do you have any thing to add. I will try to do another update on this later this month. |
@xiki-tempula not at this time, no. Apologies, it's renewals season for me and so I've had to divert attention elsewhere again. I will be able to devote some effort to this late November, so can operate on anything you put in between now and then. Feel free to leave sections you'd prefer I'd write so the load isn't all on you. |
@dotsdl @orbeckst Finally had some time to work on this during the Xmas. The word count should be between 250-1000 and we are currently roughly 900. Do you guys mind have a look? |
* MRS comments Some notes from MRS * Update joss_paper/paper.md Co-authored-by: Zhiyi Wu <[email protected]> --------- Co-authored-by: Zhiyi Wu <[email protected]>
Thank @mrshirts for the comments.
Do @mrshirts mind to also add yourself to the relevant section in the |
@xiki-tempula sorry for the delay, I haven't forgotten about this. Will get you a proper review as soon as I can, and will add in content if I see obvious gaps. |
@dotsdl Thanks! |
What's the current status on this? It would be nice to get this submitted in the next month or so - I can allocate some time to help get it happen. How can I help? |
Thanks for the reminder. Let's try to get this ready by the end of the month. |
Hi I, Shuai Liu ([email protected]), agree to be an author on this manuscript and I approve it. Affiliated with Silicon Therapeutics LLC, Boston, USA (when most of the contribution happens) |
* Add affiliation * change the order --------- Co-authored-by: Zhiyi Wu <[email protected]>
Co-authored-by: Zhiyi Wu <[email protected]>
@shuail Do you mind supply the ORCID as well, please? Thanks. |
* Update paper.md for authorship * revert the deleted names * fix the format --------- Co-authored-by: Zhiyi Wu <[email protected]>
- re-ordered affiliations to increase numerically in first occurrence in author order - updated date to today
- new section on background - move Implementation right before Core design principles Follows #328 (comment)
I am doing a final read through and will submit in the next few hours. |
- highlight contributors that are not authors on the paper: Travis Jensen (@trje3733) and Dominik Wille (@harlor) - acknowledge contributors for small fixes @helmutcarter @wehs7661 - acknowledge @VOD555 s initial contribution of code for fractional equilibration time
I submitted the paper to JOSS. Please do not close or merge this branch. Thank you to everyone! |
The JOSS Pre-Review issue is openjournals/joss-reviews#6845 . |
- fix #376 - added DOIs that were found by openjournals/joss-reviews#6845 (comment)
Co-authored-by: Pascal Merz <[email protected]>
@orbeckst I have made a quick draft of the JOSS paper.
I have only written the summary and the Statement of need and left other things as the template.
The guide line is here https://joss.readthedocs.io/en/latest/submitting.html#example-paper-and-bibliography
Co-authors
Substantial contributors to alchemlyb are invited to become authors of the paper. See #328 (comment) below for details.
Building the PDF
As part of the GitHub actions workflow, a full PDF version of the paper is built and you can download it as an artifact.
If you want to build the PDF locally you can use
pandoc