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

Draft for a JOSS paper #328

Open
wants to merge 99 commits into
base: master
Choose a base branch
from
Open

Draft for a JOSS paper #328

wants to merge 99 commits into from

Conversation

xiki-tempula
Copy link
Collaborator

@xiki-tempula xiki-tempula commented Jul 8, 2023

@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

pandoc --citeproc -o paper.pdf  paper.md

@xiki-tempula xiki-tempula linked an issue Jul 8, 2023 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Jul 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.83%. Comparing base (584588c) to head (7a2b140).

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.
📢 Have feedback on the report? Share it here.

@dotsdl
Copy link
Member

dotsdl commented Aug 21, 2023

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?

@xiki-tempula
Copy link
Collaborator Author

@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.

@dotsdl
Copy link
Member

dotsdl commented Aug 22, 2023

@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.

@davidlmobley
Copy link

davidlmobley commented Oct 17, 2023 via email

@xiki-tempula
Copy link
Collaborator Author

@dotsdl Do you have any thing to add. I will try to do another update on this later this month.

@dotsdl
Copy link
Member

dotsdl commented Oct 31, 2023

@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.

@xiki-tempula
Copy link
Collaborator Author

@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?
I have also add a new github action that renders the draft into a pdf and it shall be available as artifact of the corresponding action (.github/workflows/draft-pdf.yml / Paper Draft (push) ).

mrshirts and others added 4 commits December 30, 2023 19:05
* 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]>
@xiki-tempula
Copy link
Collaborator Author

Thank @mrshirts for the comments.

  • The alchemcial-analysis is only mentioned in one paragraph in the Statement of need section.
  • The big paragraph of ABFE is removed and one sentence has been added to the end of how to expand the solvation free energy to ABFE.
  • I didn't make a figure for solvation free energy as it is kind of awkward thing to discuss. If I only give a high-level description like I did here. Then I don't really need a figure. If I dig into more detail then it might not really be necessary as the reader might not expect that in JOSS.

Do @mrshirts mind to also add yourself to the relevant section in the Acknowledgements, please? Thank you.

@dotsdl
Copy link
Member

dotsdl commented Jan 19, 2024

@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.

@xiki-tempula
Copy link
Collaborator Author

@dotsdl Thanks!

@mrshirts
Copy link

mrshirts commented Apr 6, 2024

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?

@orbeckst
Copy link
Member

orbeckst commented Apr 6, 2024

Thanks for the reminder.

Let's try to get this ready by the end of the month.

@shuail
Copy link
Collaborator

shuail commented Jun 4, 2024

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)

brycestx and others added 2 commits June 4, 2024 08:21
* Add affiliation

* change the order

---------

Co-authored-by: Zhiyi Wu <[email protected]>
Co-authored-by: Zhiyi Wu <[email protected]>
@xiki-tempula
Copy link
Collaborator Author

@shuail Do you mind supply the ORCID as well, please? Thanks.

msoroush and others added 6 commits June 4, 2024 13:33
* 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)
@orbeckst
Copy link
Member

orbeckst commented Jun 5, 2024

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
@orbeckst
Copy link
Member

orbeckst commented Jun 5, 2024

I submitted the paper to JOSS.

Please do not close or merge this branch.

Thank you to everyone!

@orbeckst
Copy link
Member

orbeckst commented Jun 5, 2024

The JOSS Pre-Review issue is openjournals/joss-reviews#6845 .

joss_paper/paper.md Outdated Show resolved Hide resolved
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