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

JOSS paper #328

Closed
wants to merge 108 commits into from
Closed

JOSS paper #328

wants to merge 108 commits into from

Commits on Jul 8, 2023

  1. first draft

    xiki-tempula committed Jul 8, 2023
    Configuration menu
    Copy the full SHA
    d9a153b View commit details
    Browse the repository at this point in the history

Commits on Aug 21, 2023

  1. Configuration menu
    Copy the full SHA
    7816c2f View commit details
    Browse the repository at this point in the history

Commits on Dec 29, 2023

  1. Test render

    xiki-tempula committed Dec 29, 2023
    Configuration menu
    Copy the full SHA
    7d69775 View commit details
    Browse the repository at this point in the history
  2. fix end

    xiki-tempula committed Dec 29, 2023
    Configuration menu
    Copy the full SHA
    1192a1d View commit details
    Browse the repository at this point in the history
  3. update action

    xiki-tempula committed Dec 29, 2023
    Configuration menu
    Copy the full SHA
    0fc12b4 View commit details
    Browse the repository at this point in the history
  4. fix citation

    xiki-tempula committed Dec 29, 2023
    Configuration menu
    Copy the full SHA
    e8976be View commit details
    Browse the repository at this point in the history
  5. edit

    xiki-tempula committed Dec 29, 2023
    Configuration menu
    Copy the full SHA
    7816081 View commit details
    Browse the repository at this point in the history

Commits on Dec 30, 2023

  1. MRS comments (#339)

    * 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]>
    mrshirts and xiki-tempula authored Dec 30, 2023
    Configuration menu
    Copy the full SHA
    557d13d View commit details
    Browse the repository at this point in the history
  2. first fix

    xiki-tempula committed Dec 30, 2023
    Configuration menu
    Copy the full SHA
    2057c41 View commit details
    Browse the repository at this point in the history
  3. update the content

    xiki-tempula committed Dec 30, 2023
    Configuration menu
    Copy the full SHA
    aa2e189 View commit details
    Browse the repository at this point in the history
  4. update

    xiki-tempula committed Dec 30, 2023
    Configuration menu
    Copy the full SHA
    87153a0 View commit details
    Browse the repository at this point in the history
  5. Correct the figure

    xiki-tempula committed Dec 30, 2023
    Configuration menu
    Copy the full SHA
    edb9429 View commit details
    Browse the repository at this point in the history

Commits on Jan 3, 2024

  1. Configuration menu
    Copy the full SHA
    966e386 View commit details
    Browse the repository at this point in the history

Commits on Apr 6, 2024

  1. Configuration menu
    Copy the full SHA
    d040546 View commit details
    Browse the repository at this point in the history

Commits on Apr 7, 2024

  1. Configuration menu
    Copy the full SHA
    1ab91ab View commit details
    Browse the repository at this point in the history

Commits on Apr 9, 2024

  1. Configuration menu
    Copy the full SHA
    081e90c View commit details
    Browse the repository at this point in the history
  2. Some additional minor edits for internal consistency around estimator…

    …s, standard data forms
    dotsdl committed Apr 9, 2024
    Configuration menu
    Copy the full SHA
    b5c3d1d View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    ed01447 View commit details
    Browse the repository at this point in the history
  4. Set alchemlyb to lowercase throughout (stylistic choice); small rearr…

    …angement of paper metadata items
    dotsdl committed Apr 9, 2024
    Configuration menu
    Copy the full SHA
    0559c9f View commit details
    Browse the repository at this point in the history

Commits on Apr 25, 2024

  1. added Oliver as author

    orbeckst committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    13b13c7 View commit details
    Browse the repository at this point in the history
  2. consistent line breaking in markdown

    - infinite linesbreak at periods
    - hard line break at periods so that diffs are limited to sentences
    
    No text changes.
    orbeckst committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    850ec5a View commit details
    Browse the repository at this point in the history
  3. updated Acknowledgements/Contributions

    - move DD up in design
    - added OB to writing
    orbeckst committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    6e7fdb6 View commit details
    Browse the repository at this point in the history
  4. edited summary

    orbeckst committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    1c2ec9d View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    0b14e7c View commit details
    Browse the repository at this point in the history
  6. removed download stats

    Manual condastats were about 30k, condastats gace 5k, pypistats 25k for 2023-10-27 - 2024-04-24,
    so I am not sure how best to measure and in any case, these numbers will not age well in
    a paper so I am going to remove them. We can write in our cover letter that we have sizable
    downloads.
    orbeckst committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    6b202b2 View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    5002923 View commit details
    Browse the repository at this point in the history
  8. Ack/Author contrib update

    - create Author Contributions section
    - add funding to Ack section
    orbeckst committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    0ca06f6 View commit details
    Browse the repository at this point in the history

Commits on Apr 27, 2024

  1. Update paper.md with some comments.

    Some additional rephrasings and clarifications.  Also adding another reference in (will do in another commit)
    mrshirts authored Apr 27, 2024
    Configuration menu
    Copy the full SHA
    e8d57e9 View commit details
    Browse the repository at this point in the history
  2. Update paper.bib

    added Mey et al. on best practices.
    mrshirts authored Apr 27, 2024
    Configuration menu
    Copy the full SHA
    eca0066 View commit details
    Browse the repository at this point in the history

Commits on May 15, 2024

  1. add MDPOW

    orbeckst committed May 15, 2024
    Configuration menu
    Copy the full SHA
    ae955d8 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    e08a52e View commit details
    Browse the repository at this point in the history
  3. edited Implementation section

    - major rewrite: added sub headings
    - added more citations (scikit-learn, pandas, MDPOW) as well as Mey 2020
    - added design principles from https://alchemlyb.readthedocs.io/en/latest/api_principles.html
    - added full caption for figure
    - added license (BSD-3)
    orbeckst committed May 15, 2024
    Configuration menu
    Copy the full SHA
    64de66d View commit details
    Browse the repository at this point in the history

Commits on May 16, 2024

  1. Merge branch '71-joss-paper' of github.com:alchemistry/alchemlyb into…

    … 71-joss-paper
    
    - combined @MrShirt's revisions with @orbeckst's rewrite
      (we both added Mey2020...)
    - fixed small omissions on my part
    orbeckst committed May 16, 2024
    Configuration menu
    Copy the full SHA
    bfda924 View commit details
    Browse the repository at this point in the history
  2. spell checked

    orbeckst committed May 16, 2024
    Configuration menu
    Copy the full SHA
    cb5e5dc View commit details
    Browse the repository at this point in the history
  3. added David Mobley to authors

    TODO: @davidlmobley please check
    orbeckst committed May 16, 2024
    Configuration menu
    Copy the full SHA
    e6c6023 View commit details
    Browse the repository at this point in the history
  4. minor abstract edits

    orbeckst committed May 16, 2024
    Configuration menu
    Copy the full SHA
    ea900ca View commit details
    Browse the repository at this point in the history
  5. updated author contribs

    Added MRS and DM to project design.
    orbeckst committed May 16, 2024
    Configuration menu
    Copy the full SHA
    98b829e View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    7541d71 View commit details
    Browse the repository at this point in the history
  7. minor edits

    orbeckst committed May 16, 2024
    Configuration menu
    Copy the full SHA
    dc99971 View commit details
    Browse the repository at this point in the history
  8. added all other authors to acknowledgements

    source: AUTHORS file
    orbeckst committed May 16, 2024
    Configuration menu
    Copy the full SHA
    82d45a0 View commit details
    Browse the repository at this point in the history
  9. Configuration menu
    Copy the full SHA
    791c03a View commit details
    Browse the repository at this point in the history
  10. changed Author contributions: maintenance

    Changed "maintain" to "maintained" to more accurately capture
    present AND past contributions by ZW, DD, OB.
    orbeckst committed May 16, 2024
    Configuration menu
    Copy the full SHA
    cf04861 View commit details
    Browse the repository at this point in the history
  11. funding ack

    State that funds were not involved, per guidelines/policies
    https://joss.readthedocs.io/en/latest/submitting.html#policies
    orbeckst committed May 16, 2024
    Configuration menu
    Copy the full SHA
    3f39574 View commit details
    Browse the repository at this point in the history
  12. Configuration menu
    Copy the full SHA
    834ed86 View commit details
    Browse the repository at this point in the history
  13. add ASU to @dotsdl affiliation

    orbeckst committed May 16, 2024
    Configuration menu
    Copy the full SHA
    7d56536 View commit details
    Browse the repository at this point in the history
  14. use referencing for figure

    orbeckst committed May 16, 2024
    Configuration menu
    Copy the full SHA
    3dad66f View commit details
    Browse the repository at this point in the history
  15. add ASU to @dotsdl 's affiliation

    orbeckst committed May 16, 2024
    Configuration menu
    Copy the full SHA
    950b1d8 View commit details
    Browse the repository at this point in the history
  16. Configuration menu
    Copy the full SHA
    bf9c515 View commit details
    Browse the repository at this point in the history
  17. reference update/cleanup

    - use canonical reference for Amber (and write software name
      as "Amber" instead of "AMBER" as in the paper/website)
    - use more recent GROMACS reference
    - use software / JOSS citation for BioSimSpace (instead of
      tutorial reference)
    - use proper GOMC reference (note that the 2021 is the one containing
      free energy calculations)
    - added DOIs to references
    - fixed treatment of "Jr"
    orbeckst committed May 16, 2024
    Configuration menu
    Copy the full SHA
    e3ee72c View commit details
    Browse the repository at this point in the history
  18. use hyperlinks instead of bare URLs

    - attach all URLs to anchors
    - add URLs for software packages
    orbeckst committed May 16, 2024
    Configuration menu
    Copy the full SHA
    1ae8464 View commit details
    Browse the repository at this point in the history
  19. Configuration menu
    Copy the full SHA
    a9809d2 View commit details
    Browse the repository at this point in the history

Commits on May 21, 2024

  1. Configuration menu
    Copy the full SHA
    f21f170 View commit details
    Browse the repository at this point in the history
  2. add PDF for author review

    orbeckst committed May 21, 2024
    Configuration menu
    Copy the full SHA
    4d79965 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    1bde8d1 View commit details
    Browse the repository at this point in the history

Commits on May 22, 2024

  1. Configuration menu
    Copy the full SHA
    6344006 View commit details
    Browse the repository at this point in the history
  2. JOSS paper: Add T. Joseph to authors and grant to acknowledgements (#362

    )
    
    * Add T. Joseph to authors and grant to acknowledgements
    
    * Remove TTJ from Acknowledgements, add to Author Contributions
    ttjoseph authored May 22, 2024
    Configuration menu
    Copy the full SHA
    4fc3ee5 View commit details
    Browse the repository at this point in the history

Commits on May 23, 2024

  1. Configuration menu
    Copy the full SHA
    adf5a26 View commit details
    Browse the repository at this point in the history

Commits on May 25, 2024

  1. Configuration menu
    Copy the full SHA
    414320d View commit details
    Browse the repository at this point in the history

Commits on May 27, 2024

  1. edits by Alexander Schlaich

    - add @schlaicha to authors
    - edits throughout, in particular emphasis on general simulation packages (not just MD)
    
    Co-authored-by: Alexander Schlaich <[email protected]>
    orbeckst and schlaicha authored May 27, 2024
    Configuration menu
    Copy the full SHA
    f663f50 View commit details
    Browse the repository at this point in the history
  2. additional edis suggested by @schlaicha

    - add LAMMPS to list of packages
    - add more references (LAMMPS, paper for free energy in materials)
    - only talk about MD later, keep it initially general
    orbeckst committed May 27, 2024
    Configuration menu
    Copy the full SHA
    4a0d892 View commit details
    Browse the repository at this point in the history
  3. add @schlaicha to paper writers

    orbeckst committed May 27, 2024
    Configuration menu
    Copy the full SHA
    0a4291b View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    bc3b7fb View commit details
    Browse the repository at this point in the history

Commits on May 28, 2024

  1. Add JH to author lists, extra reference (#365)

    * Add mention of SAFEP
    
    * Add JH to author list, first SAFEP reference
    
    also reorder middle authors alphabetically.
    
    ---------
    
    Co-authored-by: Tom Joseph <[email protected]>
    jhenin and ttjoseph authored May 28, 2024
    Configuration menu
    Copy the full SHA
    1f01ec7 View commit details
    Browse the repository at this point in the history
  2. Add HL to author list with affiliation (#366)

    * Add HL to author list with affiliation
    
    * update
    
    * update
    lee212 authored May 28, 2024
    Configuration menu
    Copy the full SHA
    b7b15cb View commit details
    Browse the repository at this point in the history
  3. Add Ian Kenney to author list (#367)

    * Added Ian M. Kenney to author list
    
    * Added I.M.K. to author contributions
    ianmkenney authored May 28, 2024
    Configuration menu
    Copy the full SHA
    1161e03 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    6260d21 View commit details
    Browse the repository at this point in the history
  5. fixed typo LAMPPS -> LAMMPS

    jhenin authored and orbeckst committed May 28, 2024
    Configuration menu
    Copy the full SHA
    29aee32 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    ae2bd7c View commit details
    Browse the repository at this point in the history
  7. software engineering details and minor touch-ups

    - state that we follow NEP29 (transition to SPEC0, which is basically the same for us)
    - state that we use SemVer
    - minor text fixes throughout and adding of citations where needed
    orbeckst committed May 28, 2024
    Configuration menu
    Copy the full SHA
    1c1bc71 View commit details
    Browse the repository at this point in the history
  8. update @orbeckst's affiliation

    orbeckst committed May 28, 2024
    Configuration menu
    Copy the full SHA
    be4c2e7 View commit details
    Browse the repository at this point in the history

Commits on May 29, 2024

  1. using SPEC 0 (updated from NEP29)

    Changed with #369
    orbeckst committed May 29, 2024
    Configuration menu
    Copy the full SHA
    9b2657e View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    d0be813 View commit details
    Browse the repository at this point in the history

Commits on May 30, 2024

  1. Configuration menu
    Copy the full SHA
    00e4f10 View commit details
    Browse the repository at this point in the history
  2. PDF draft of paper as of 2024-05-30

    REMOVE BEFORE SUBMISSION
    orbeckst committed May 30, 2024
    Configuration menu
    Copy the full SHA
    d9df3e4 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    4c7a82f View commit details
    Browse the repository at this point in the history
  4. update information for David Mobley

    - add department
    - add grant information
    davidlmobley authored and orbeckst committed May 30, 2024
    Configuration menu
    Copy the full SHA
    4bcf959 View commit details
    Browse the repository at this point in the history

Commits on May 31, 2024

  1. fix DM affiliation

    Co-authored-by: Ian Kenney <[email protected]>
    orbeckst and ianmkenney authored May 31, 2024
    Configuration menu
    Copy the full SHA
    19c963c View commit details
    Browse the repository at this point in the history
  2. add @vtlim to Author list

    vtlim authored and orbeckst committed May 31, 2024
    Configuration menu
    Copy the full SHA
    767e89f View commit details
    Browse the repository at this point in the history

Commits on Jun 3, 2024

  1. Update joss_paper/paper.md

    Co-authored-by: Pascal Merz <[email protected]>
    xiki-tempula and ptmerz authored Jun 3, 2024
    Configuration menu
    Copy the full SHA
    5fe9ec9 View commit details
    Browse the repository at this point in the history

Commits on Jun 4, 2024

  1. Add affiliation (#374)

    * Add affiliation
    
    * change the order
    
    ---------
    
    Co-authored-by: Zhiyi Wu <[email protected]>
    brycestx and xiki-tempula authored Jun 4, 2024
    Configuration menu
    Copy the full SHA
    41285c3 View commit details
    Browse the repository at this point in the history
  2. Update paper.md (#373)

    Co-authored-by: Zhiyi Wu <[email protected]>
    ptmerz and xiki-tempula authored Jun 4, 2024
    Configuration menu
    Copy the full SHA
    bc46b48 View commit details
    Browse the repository at this point in the history
  3. Update paper.md for authorship (#375)

    * Update paper.md for authorship
    
    * revert the deleted names
    
    * fix the format
    
    ---------
    
    Co-authored-by: Zhiyi Wu <[email protected]>
    msoroush and xiki-tempula authored Jun 4, 2024
    Configuration menu
    Copy the full SHA
    74d164a View commit details
    Browse the repository at this point in the history
  4. finalized author information and date

    - re-ordered affiliations to increase numerically in first occurrence in
      author order
    - updated date to today
    orbeckst committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    388dc54 View commit details
    Browse the repository at this point in the history
  5. introduce alchemical free energy calcs outside Implementation section

    - new section on background
    - move Implementation right before Core design principles
    
    Follows #328 (comment)
    ptmerz authored and orbeckst committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    9215695 View commit details
    Browse the repository at this point in the history

Commits on Jun 5, 2024

  1. Configuration menu
    Copy the full SHA
    f9f5429 View commit details
    Browse the repository at this point in the history
  2. fixed front matter

    orbeckst committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    85226d5 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    1902b70 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    463ce35 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    9706f56 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    3926c0c View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    9fa2352 View commit details
    Browse the repository at this point in the history
  8. re-numbered affiliations

    orbeckst committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    a61bddc View commit details
    Browse the repository at this point in the history
  9. finalized acknowledgements

    - 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 committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    d124059 View commit details
    Browse the repository at this point in the history
  10. Configuration menu
    Copy the full SHA
    df864a7 View commit details
    Browse the repository at this point in the history
  11. Configuration menu
    Copy the full SHA
    cd991d9 View commit details
    Browse the repository at this point in the history
  12. add missing DOIs

    - fix #376
    - added DOIs that were found by openjournals/joss-reviews#6845 (comment)
    orbeckst committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    e85a327 View commit details
    Browse the repository at this point in the history
  13. add DOI for Kirkwood 1935

    orbeckst committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    4cbea4c View commit details
    Browse the repository at this point in the history

Commits on Jun 6, 2024

  1. Fix name Hu -> Hsu in Ack

    Co-authored-by: Pascal Merz <[email protected]>
    orbeckst and ptmerz authored Jun 6, 2024
    Configuration menu
    Copy the full SHA
    4f01ac8 View commit details
    Browse the repository at this point in the history

Commits on Jun 26, 2024

  1. Update affiliation

    xiki-tempula authored Jun 26, 2024
    Configuration menu
    Copy the full SHA
    7a2b140 View commit details
    Browse the repository at this point in the history

Commits on Jul 18, 2024

  1. Configuration menu
    Copy the full SHA
    2fca23e View commit details
    Browse the repository at this point in the history

Commits on Jul 27, 2024

  1. Configuration menu
    Copy the full SHA
    0fcae51 View commit details
    Browse the repository at this point in the history

Commits on Aug 15, 2024

  1. Configuration menu
    Copy the full SHA
    42f3c46 View commit details
    Browse the repository at this point in the history

Commits on Aug 17, 2024

  1. Minor changes to the paper (#387)

    * update
    
    * remove doi
    
    * add orcid
    xiki-tempula authored Aug 17, 2024
    Configuration menu
    Copy the full SHA
    1f32e88 View commit details
    Browse the repository at this point in the history

Commits on Sep 5, 2024

  1. Configuration menu
    Copy the full SHA
    464c2cf View commit details
    Browse the repository at this point in the history

Commits on Sep 17, 2024

  1. Configuration menu
    Copy the full SHA
    dd117d8 View commit details
    Browse the repository at this point in the history

Commits on Sep 19, 2024

  1. Configuration menu
    Copy the full SHA
    acac89d View commit details
    Browse the repository at this point in the history
  2. add @jaclark5 to acknowledgements

    - acknowledging recent additions to 2.4.0 and 2.4.1 release (after the review of the manuscript)
    - approved in #328 (comment)
    orbeckst authored Sep 19, 2024
    Configuration menu
    Copy the full SHA
    4f7e2db View commit details
    Browse the repository at this point in the history

Commits on Sep 24, 2024

  1. Configuration menu
    Copy the full SHA
    27caba8 View commit details
    Browse the repository at this point in the history