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
Show file tree
Hide file tree
Changes from 97 commits
Commits
Show all changes
108 commits
Select commit Hold shift + click to select a range
d9a153b
first draft
xiki-tempula Jul 8, 2023
7816c2f
Merge branch 'master' into 71-joss-paper
dotsdl Aug 21, 2023
7d69775
Test render
xiki-tempula Dec 29, 2023
1192a1d
fix end
xiki-tempula Dec 29, 2023
0fc12b4
update action
xiki-tempula Dec 29, 2023
e8976be
fix citation
xiki-tempula Dec 29, 2023
7816081
edit
xiki-tempula Dec 29, 2023
557d13d
MRS comments (#339)
mrshirts Dec 30, 2023
2057c41
first fix
xiki-tempula Dec 30, 2023
aa2e189
update the content
xiki-tempula Dec 30, 2023
87153a0
update
xiki-tempula Dec 30, 2023
edb9429
Correct the figure
xiki-tempula Dec 30, 2023
966e386
Merge branch 'master' into 71-joss-paper
xiki-tempula Jan 3, 2024
d040546
Merge branch 'master' into 71-joss-paper
orbeckst Apr 6, 2024
1ab91ab
Merge branch 'master' into 71-joss-paper
xiki-tempula Apr 7, 2024
081e90c
Small edits, clauses set as newlines for easier diffs
dotsdl Apr 9, 2024
b5c3d1d
Some additional minor edits for internal consistency around estimator…
dotsdl Apr 9, 2024
ed01447
Small rearrangement of metadata items
dotsdl Apr 9, 2024
0559c9f
Set alchemlyb to lowercase throughout (stylistic choice); small rearr…
dotsdl Apr 9, 2024
13b13c7
added Oliver as author
orbeckst Apr 25, 2024
850ec5a
consistent line breaking in markdown
orbeckst Apr 25, 2024
6e7fdb6
updated Acknowledgements/Contributions
orbeckst Apr 25, 2024
1c2ec9d
edited summary
orbeckst Apr 25, 2024
0b14e7c
WIP: editing statement of need
orbeckst Apr 25, 2024
6b202b2
removed download stats
orbeckst Apr 25, 2024
5002923
completed editing of Statement of need section
orbeckst Apr 25, 2024
0ca06f6
Ack/Author contrib update
orbeckst Apr 25, 2024
e8d57e9
Update paper.md with some comments.
mrshirts Apr 27, 2024
eca0066
Update paper.bib
mrshirts Apr 27, 2024
ae955d8
add MDPOW
orbeckst May 15, 2024
e08a52e
add fractional equilibration time
orbeckst May 15, 2024
64de66d
edited Implementation section
orbeckst May 15, 2024
bfda924
Merge branch '71-joss-paper' of github.com:alchemistry/alchemlyb into…
orbeckst May 16, 2024
cb5e5dc
spell checked
orbeckst May 16, 2024
e6c6023
added David Mobley to authors
orbeckst May 16, 2024
ea900ca
minor abstract edits
orbeckst May 16, 2024
98b829e
updated author contribs
orbeckst May 16, 2024
7541d71
fix citation syntax
orbeckst May 16, 2024
dc99971
minor edits
orbeckst May 16, 2024
82d45a0
added all other authors to acknowledgements
orbeckst May 16, 2024
791c03a
Merge branch 'master' into 71-joss-paper
orbeckst May 16, 2024
cf04861
changed Author contributions: maintenance
orbeckst May 16, 2024
3f39574
funding ack
orbeckst May 16, 2024
834ed86
minor edit (use MD after first definition)
orbeckst May 16, 2024
7d56536
add ASU to @dotsdl affiliation
orbeckst May 16, 2024
3dad66f
use referencing for figure
orbeckst May 16, 2024
950b1d8
add ASU to @dotsdl 's affiliation
orbeckst May 16, 2024
bf9c515
add @dotsdl to "wrote paper" in contributions as he was missing from …
orbeckst May 16, 2024
e3ee72c
reference update/cleanup
orbeckst May 16, 2024
1ae8464
use hyperlinks instead of bare URLs
orbeckst May 16, 2024
a9809d2
update artifact upload action
orbeckst May 16, 2024
f21f170
Merge branch 'master' into 71-joss-paper
orbeckst May 21, 2024
4d79965
add PDF for author review
orbeckst May 21, 2024
1bde8d1
used DLD instead of DD for @dotsdl
orbeckst May 21, 2024
6344006
added my name (#361)
DrDomenicoMarson May 22, 2024
4fc3ee5
JOSS paper: Add T. Joseph to authors and grant to acknowledgements (#…
ttjoseph May 22, 2024
adf5a26
add name and minor change (#363)
hl2500 May 23, 2024
414320d
Merge branch 'master' into 71-joss-paper
xiki-tempula May 25, 2024
f663f50
edits by Alexander Schlaich
orbeckst May 27, 2024
4a0d892
additional edis suggested by @schlaicha
orbeckst May 27, 2024
0a4291b
add @schlaicha to paper writers
orbeckst May 27, 2024
bc3b7fb
name the JOSS paper build workflow
orbeckst May 27, 2024
1f01ec7
Add JH to author lists, extra reference (#365)
jhenin May 28, 2024
b7b15cb
Add HL to author list with affiliation (#366)
lee212 May 28, 2024
1161e03
Add Ian Kenney to author list (#367)
ianmkenney May 28, 2024
6260d21
Move JH from Acknowledgments to Contributions (#368)
jhenin May 28, 2024
29aee32
fixed typo LAMPPS -> LAMMPS
jhenin May 28, 2024
ae2bd7c
fiddle with bib to make JC Chodera citations appear unformly
orbeckst May 28, 2024
1c1bc71
software engineering details and minor touch-ups
orbeckst May 28, 2024
be4c2e7
update @orbeckst's affiliation
orbeckst May 28, 2024
9b2657e
using SPEC 0 (updated from NEP29)
orbeckst May 29, 2024
d0be813
Merge branch 'master' into 71-joss-paper
orbeckst May 29, 2024
00e4f10
Add Irfan Alibay to paper.md (#372)
IAlibay May 30, 2024
d9df3e4
PDF draft of paper as of 2024-05-30
orbeckst May 30, 2024
4c7a82f
Merge branch '71-joss-paper' of github.com:alchemistry/alchemlyb into…
orbeckst May 30, 2024
4bcf959
update information for David Mobley
davidlmobley May 30, 2024
19c963c
fix DM affiliation
orbeckst May 31, 2024
767e89f
add @vtlim to Author list
vtlim May 31, 2024
5fe9ec9
Update joss_paper/paper.md
xiki-tempula Jun 3, 2024
41285c3
Add affiliation (#374)
brycestx Jun 4, 2024
bc46b48
Update paper.md (#373)
ptmerz Jun 4, 2024
74d164a
Update paper.md for authorship (#375)
msoroush Jun 4, 2024
388dc54
finalized author information and date
orbeckst Jun 4, 2024
9215695
introduce alchemical free energy calcs outside Implementation section
ptmerz Jun 4, 2024
f9f5429
edited paragraph on solvation free energy calc to improve clarity
ptmerz Jun 5, 2024
85226d5
fixed front matter
orbeckst Jun 5, 2024
1902b70
add PTM to "wrote manuscript"
orbeckst Jun 5, 2024
463ce35
add Shuai Li to authors (but need to renumber affiliations)
orbeckst Jun 5, 2024
9706f56
Fix Shuai Liu’s name (sorry)
orbeckst Jun 5, 2024
3926c0c
Updated author order and contributions
orbeckst Jun 5, 2024
9fa2352
full author list for NAMD paper
orbeckst Jun 5, 2024
a61bddc
re-numbered affiliations
orbeckst Jun 5, 2024
d124059
finalized acknowledgements
orbeckst Jun 5, 2024
df864a7
clean up: removed PDF versions
orbeckst Jun 5, 2024
cd991d9
fixed name of Wei-Tse Hu in Ack
orbeckst Jun 5, 2024
e85a327
add missing DOIs
orbeckst Jun 5, 2024
4cbea4c
add DOI for Kirkwood 1935
orbeckst Jun 5, 2024
4f01ac8
Fix name Hu -> Hsu in Ack
orbeckst Jun 6, 2024
7a2b140
Update affiliation
xiki-tempula Jun 26, 2024
2fca23e
Merge branch 'master' into 71-joss-paper
orbeckst Jul 18, 2024
0fcae51
Merge branch 'master' into 71-joss-paper
orbeckst Jul 27, 2024
42f3c46
Merge branch 'master' into 71-joss-paper
orbeckst Aug 15, 2024
1f32e88
Minor changes to the paper (#387)
xiki-tempula Aug 17, 2024
464c2cf
Merge branch 'master' into 71-joss-paper
orbeckst Sep 5, 2024
dd117d8
Merge branch 'master' into 71-joss-paper
orbeckst Sep 17, 2024
acac89d
Merge branch 'master' into 71-joss-paper
orbeckst Sep 19, 2024
4f7e2db
add @jaclark5 to acknowledgements
orbeckst Sep 19, 2024
27caba8
paper affiliations: spell out USA
orbeckst Sep 24, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/draft-pdf.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: JOSS paper build

on: [push]

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
# This should be the path to the paper within your repo.
paper-path: joss_paper/paper.md
- name: Upload
uses: actions/upload-artifact@v4
with:
name: paper
# This is the output path where Pandoc will write the compiled
# PDF. Note, this should be the same directory as the input
# paper.md
path: joss_paper/paper.pdf
Binary file added joss_paper/Fig1.pdf
Binary file not shown.
320 changes: 320 additions & 0 deletions joss_paper/paper.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,320 @@
@article{bennett1976efficient,
title={Efficient estimation of free energy differences from Monte Carlo data},
author={Bennett, C. H.},
journal={Journal of Computational Physics},
volume={22},
number={2},
pages={245-268},
year={1976},
doi={10.1016/0021-9991(76)90078-4},
}


@article{Case2005uq,
author = {Case, David A and Cheatham, 3rd, Thomas E and Darden, Tom and Gohlke, Holger and Luo, Ray and Merz, Jr, Kenneth M and Onufriev, Alexey and Simmerling, Carlos and Wang, Bing and Woods, Robert J},
journal = {J Comput Chem},
number = {16},
pages = {1668-1688},
title = {The {Amber} biomolecular simulation programs},
volume = {26},
year = {2005},
doi = {10.1002/jcc.20290}
}


@article{chodera2007use,
title={Use of the Weighted Histogram Analysis Method for the Analysis of Simulated and Parallel Tempering Simulations},
author={J. D. Chodera and Swope, W. C. and Pitera, J. W. and Seok, C. and Dill, K. A.},
journal={J Chem Theory Comput},
volume={3},
number={1},
pages={26-41},
year={2007},
doi={10.1021/ct0502864},
}


@article{Nejahi2021aa,
author = {Younes Nejahi and Mohammad Soroush Barhaghi and Gregory Schwing and Loren Schwiebert and Jeffrey Potoff},
journal = {SoftwareX},
pages = {100627},
title = {Update 2.70 to ``{GOMC}: {GPU} Optimized {Monte Carlo} for the simulation of phase equilibria and physical properties of complex fluids''},
volume = {13},
doi = {10.1016/j.softx.2020.100627},
year = {2021}
}


@article{deng2009computations,
title={Computations of standard binding free energies with molecular dynamics simulations},
author={Deng, Y. and Roux, B.},
journal={J Phys Chem B},
volume={113},
number={8},
pages={2234-2246},
year={2009},
doi={10.1021/jp807701h},
}

@article{gusev2023active,
title={Active Learning Guided Drug Design Lead Optimization Based on Relative Binding Free Energy Modeling},
author={Gusev, F. and Gutkin, E. and Kurnikova, M. G. and Isayev, O.},
journal={Journal of Chemical Information and Modeling},
volume={63},
number={2},
pages={583-594},
year={2023},
doi={10.1021/acs.jcim.2c01052},
}


@article{Hedges2019aa,
author = {Lester O. Hedges and Antonia S.J.S. Mey and Charles A. Laughton and Francesco L. Gervasio and Adrian J. Mulholland and Christopher J. Woods and Julien Michel},
journal = {Journal of Open Source Software},
keywords = {free energy, framework, python, MD SIMULATION},
number = {43},
pages = {1831},
publisher = {The Open Journal},
title = {{BioSimSpace}: An interoperable {Python} framework for biomolecular simulation},
volume = {4},
year = {2019},
doi = {10.21105/joss.01831}
}

@article{kirkwood1935statistical,
title={Statistical mechanics of fluid mixtures},
author={Kirkwood, J. G.},
journal={The Journal of Chemical Physics},
volume={3},
number={5},
pages={300-313},
year={1935},
doi={10.1063/1.1749657},
}

@article{klimovich2015guidelines,
title={Guidelines for the analysis of free energy calculations},
author={Klimovich, P. V. and Shirts, M. R. and Mobley, D. L.},
journal={J Comput Aided Mol Des},
volume={29},
number={5},
pages={397-411},
year={2015},
doi={10.1007/s10822-015-9840-9},
}

@book{merz2010drug,
title={Drug design: structure-and ligand-based approaches},
author={Merz, Jr, K. M. and Ringe, D. and Reynolds, C. H.},
year={2010},
publisher={Cambridge University Press},
}

@article{paliwal2011benchmark,
title={A Benchmark Test Set for Alchemical Free Energy Transformations and Its Use to Quantify Error in Common Free Energy Methods},
author={Paliwal, H. and Shirts, M. R.},
journal={J Chem Theory Comput},
volume={7},
number={12},
pages={4115-4134},
year={2011},
doi={10.1021/ct2003995},
}

@article{pham2011identifying,
title={Identifying low variance pathways for free energy calculations of molecular transformations in solution phase},
author={Pham, T. T. and Shirts, M. R.},
journal={J Chem Phys},
volume={135},
number={3},
pages={034114},
year={2011},
doi={10.1063/1.3607597},
}

@article{phillips2020scalable,
title={Scalable molecular dynamics on CPU and GPU architectures with NAMD},
author = {Phillips,James C. and Hardy,David J. and Maia,Julio D. C. and Stone,John E. and Ribeiro,Jo{\~a}o V. and Bernardi,Rafael C. and Buch,Ronak and Fiorin,Giacomo and H{\'e}nin,J{\'e}r{\^o}me and Jiang,Wei and McGreevy,Ryan and Melo,Marcelo C. R. and Radak,Brian K. and Skeel,Robert D. and Singharoy,Abhishek and Wang,Yi and Roux,Beno{\^\i}t and Aksimentiev,Aleksei and Luthey-Schulten,Zaida and Kal{\'e},Laxmikant V. and Schulten,Klaus and Chipot,Christophe and Tajkhorshid,Emad},
journal={The Journal of Chemical Physics},
volume={153},
number={4},
pages={044130},
year={2020},
doi={10.1063/5.0014475},
}

@article{pohorille2010good,
title={Good practices in free-energy calculations},
author={Pohorille, A. and Jarzynski, C. and Chipot, C.},
journal={J Phys Chem B},
volume={114},
number={32},
pages={10235-10253},
year={2010},
doi={10.1021/jp102971x},
}


@article{Abraham2015aa,
author = {Abraham, Mark James and Murtola, Teemu and Schulz, Roland and P{\'a}ll, Szil{\'a}rd and Smith, Jeremy C. and Hess, Berk and Lindahl, Erik},
journal = {SoftwareX},
pages = {19 - 25},
title = {{GROMACS}: High performance molecular simulations through multi-level parallelism from laptops to supercomputers},
volume = {1--2},
year = {2015},
doi = {10.1016/j.softx.2015.06.001}
}

@article{shirts2008statistically,
title={Statistically optimal analysis of samples from multiple equilibrium states},
author={Shirts, M. R. and Chodera, J. D.},
journal={J Chem Phys},
volume={129},
number={12},
pages={124105},
year={2008},
doi={10.1063/1.2978177},
}

@article{yang2004free,
title={Free energy simulations: use of reverse cumulative averaging to determine the equilibrated region and the time required for convergence},
author={Yang, W. and Bitetti-Putzer, R. and Karplus, M.},
journal={J Chem Phys},
volume={120},
number={6},
pages={2618-2628},
year={2004},
doi={10.1063/1.1638996},
}

@article{zwanzig1954high,
title={High‐temperature equation of state by a perturbation method. I. Nonpolar gases},
author={Zwanzig, R. W.},
journal={The Journal of Chemical Physics},
volume={22},
number={8},
pages={1420-1426},
year={1954},
doi={10.1063/1.1740409},
}

@article{fan2020aa,
author = {Fan, Shujie and Iorga, Bogdan I. and Beckstein, Oliver},
journal = {Journal of Computer-Aided Molecular Design},
pages = {543--560},
title = {Prediction of octanol-water partition coefficients for the {SAMPL6}-{$\log P$} molecules using molecular dynamics simulations with {OPLS-AA}, {AMBER} and {CHARMM} force fields},
volume = {34},
year = {2020},
doi = {10.1007/s10822-019-00267-z}
}


@article{Mey2020aa,
author = {Antonia S. J. S. Mey and Bryce Allen and Hannah E. Bruce Macdonald and John D. Chodera and Maximilian Kuhn and Julien Michel and David L. Mobley and Levi N. Naden and Samarjeet Prasad and Andrea Rizzi and Jenke Scheen and Michael R. Shirts and Gary Tresadern and Huafeng Xu},
journal = {Living Journal of Computational Molecular Science},
number = {1},
pages = {18378},
title = {Best Practices for Alchemical Free Energy Calculations},
volume = {2},
year = {2020},
doi = {10.33011/livecoms.2.1.18378}
}


@article{Chodera2016aa,
author = {J. D. Chodera},
journal = {Journal of Chemical Theory and Computation},
month = {Apr},
number = {4},
pages = {1799--1805},
title = {A Simple Method for Automated Equilibration Detection in Molecular Simulations},
volume = {12},
year = {2016},
doi = {10.1021/acs.jctc.5b00784}
}

@InProceedings{ mckinney-proc-scipy-2010,
author = { {W}es {M}c{K}inney },
title = { {D}ata {S}tructures for {S}tatistical {C}omputing in {P}ython },
booktitle = { {P}roceedings of the 9th {P}ython in {S}cience {C}onference },
pages = { 56 - 61 },
year = { 2010 },
editor = { {S}t\'efan van der {W}alt and {J}arrod {M}illman },
doi = { 10.25080/Majora-92bf1922-00a }
}


@article{scikitlearn2011,
title={Scikit-learn: Machine Learning in {P}ython},
author={Pedregosa, F. and Varoquaux, G. and Gramfort, A. and Michel, V.
and Thirion, B. and Grisel, O. and Blondel, M. and Prettenhofer, P.
and Weiss, R. and Dubourg, V. and Vanderplas, J. and Passos, A. and
Cournapeau, D. and Brucher, M. and Perrot, M. and Duchesnay, E.},
journal={Journal of Machine Learning Research},
volume={12},
pages={2825--2830},
year={2011}
}

@inproceedings{sklearn2013api,
author = {Lars Buitinck and Gilles Louppe and Mathieu Blondel and
Fabian Pedregosa and Andreas Mueller and Olivier Grisel and
Vlad Niculae and Peter Prettenhofer and Alexandre Gramfort
and Jaques Grobler and Robert Layton and Jake VanderPlas and
Arnaud Joly and Brian Holt and Ga{\"{e}}l Varoquaux},
title = {{API} design for machine learning software: experiences from the scikit-learn
project},
booktitle = {ECML PKDD Workshop: Languages for Data Mining and Machine Learning},
year = {2013},
pages = {108--122},
}


@incollection{Schlaich2015aa,
address = {J{\"u}lich},
author = {Schlaich, A and Kowalik, B and Kandu{\v{c}}, M and Schneck, Emanuel and Netz, RR},
booktitle = {Computational Trends in Solvation and Transport in Liquids-Lecture Notes (IAS Series 28)},
editor = {Sutmann, G. and Grotendorst, J. and Gompper, G. and Marx, D.},
pages = {155--185},
publisher = {Forschungszentrum J{\"u}lich GmbH},
title = {Simulation techniques for solvation-induced surface-interactions at prescribed water chemical potential},
volume = 28,
year = 2015
}


@article{Thompson2022aa,
author = {Aidan P. Thompson and H. Metin Aktulga and Richard Berger and Dan S. Bolintineanu and W. Michael Brown and Paul S. Crozier and Pieter J. {in 't Veld} and Axel Kohlmeyer and Stan G. Moore and Trung Dac Nguyen and Ray Shan and Mark J. Stevens and Julien Tranchida and Christian Trott and Steven J. Plimpton},
journal = {Computer Physics Communications},
pages = 108171,
title = {{LAMMPS} - a flexible simulation tool for particle-based materials modeling at the atomic, meso, and continuum scales},
volume = 271,
year = 2022,
doi = {10.1016/j.cpc.2021.108171},
}


@Article{Salari2018,
author = {Salari, Reza and Joseph, Thomas and Lohia, Ruchi and Hénin, Jérôme and Brannigan, Grace},
title = {A Streamlined, General Approach for Computing Ligand Binding Free Energies and Its Application to GPCR-Bound Cholesterol.},
journal = {Journal of Chemical Theory and Computation},
year = {2018},
volume = {14},
number = {12},
pages = {6560--6573},
doi = {10.1021/acs.jctc.8b00447},
}


@article{santiagomcrae2023,
author={Santiago-McRae, E., and Ebrahimi, M. and Sandberg, J. W. and Brannigan, G. and Hénin, J.},
title={Computing Absolute Binding Affinities by Streamlined Alchemical Free Energy Perturbation (SAFEP) [Article v1.0]},
url={https://livecomsjournal.org/index.php/livecoms/article/view/v5i1e2067},
doi={10.33011/livecoms.5.1.2067},
journal={Living Journal of Computational Molecular Science},
year={2023},
month={Oct.},
volume={5},
number={1},
pages={2067}
}
Loading
Loading