Skip to content

Commit cd4b23f

Browse files
committed
Add info on how to cite to README.md
1 parent 6232ca8 commit cd4b23f

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,20 @@ Additionally, all release versions -- current and prior -- are available via Zen
1010

1111
## The paper
1212

13+
### Versions
14+
1315
The most up-to-date version of our perpetual review paper always available [here](https://github.com/MobleyLab/benchmarksets/blob/master/paper/benchmarkset.pdf).
1416
Additionally, this repository provides the authoritative source for all versions of this paper.
1517
Released versions of the paper are also archived as preprints on [eScholarship](http://escholarship.org/uc/item/9p37m6bq), and have Zenodo DOIs as noted above.
1618
An early version of this work was published in [Annual Review of Biophysics 46:531-558 (2017)](https://doi.org/10.1146/annurev-biophys-070816-033654).
1719

20+
### Publication in Annual Review
21+
1822
While a portion of this work was originally published with Annual Review, the version here is substantially expanded and updated, and will continue to deviate further from the AR version.
1923
Thus, we refer to this version as the "perpetual review version" and this is refelected in its title.
2024

25+
### Ongoing updates and credit
26+
2127
Source files for the paper are deposited here on this GitHub repository, as detailed below, and comments/suggestions, etc. are welcome via the issue tracker (https://github.com/MobleyLab/benchmarksets/issues).
2228

2329
The Annual Review portion of this work is posted with permission from the Annual Review of Biophysics, Volume 46 © 2017 by [Annual Reviews](http://www.annualreviews.org/).
@@ -26,16 +32,22 @@ The right to create derivative works (exercised here) is also exercised with per
2632

2733
A list of authors is provided below.
2834

35+
### Citing this work
36+
37+
To cite this work, please cite both:
38+
- The latest eScholarship version (archiving point releases of this repo) at [`https://escholarship.org/uc/item/9p37m6bq`](https://escholarship.org/uc/item/9p37m6bq), with the authors currently listed there and the title "Predicting binding free energies: Frontiers and benchmarks (a perpetual review)"
39+
- Our Annual Review in Biophysics work ([DOI](https://doi.org/10.1146/annurev-biophys-070816-033654))
40+
2941

3042
## The vision
3143

32-
The field vitally needs benchmark sets to test and advance free energy calculations, as we detail in our paper.
44+
The field vitally needs benchmark sets to test and advance free energy calculations, as we detail in our paper.
3345
Currently, there are no such standard benchmark systems.
34-
And when good test systems are found, the relevant data tends to be published but then forgotten, and never becomes widely available.
46+
And when good test systems are found, the relevant data tends to be published but then forgotten, and never becomes widely available.
3547
Here, we want the community to be involved in selecting benchmark systems, highlighting their key challenges, and making the data and results readily available to drive new science.
3648

37-
To make this happen, we need community input.
38-
Please bring new, relevant work to our attention, including experimental or modeling work on the benchmark systems currently available here, or new work on systems that might make good candidate benchmark systems for the future.
49+
To make this happen, we need community input.
50+
Please bring new, relevant work to our attention, including experimental or modeling work on the benchmark systems currently available here, or new work on systems that might make good candidate benchmark systems for the future.
3951
And please help us create consensus around a modest set of benchmark systems which can be used to drive forward progress in the field.
4052

4153

@@ -49,7 +61,7 @@ Currently proposed benchmark sets are detailed in [the paper](https://github.com
4961
* Lysozyme model binding sites
5062
* apolar L99A
5163
* polar L99A/M102Q
52-
* Bromodomain BRD4-1
64+
* Bromodomain BRD4-1
5365

5466
Other near-term candidates include:
5567
* Thrombin
@@ -96,24 +108,25 @@ Please note that GitHub's automatic "contributors" list does not provide a full
96108

97109
## Versions
98110
- [AR](https://doi.org/10.1146/annurev-biophys-070816-033654): Annual Review in Biophysics 46:531-558 (2017). This version split from this repo around the time of the 1.0 release below.
99-
- [v1.0](https://github.com/MobleyLab/benchmarksets/releases/tag/v1.0): As posted to [bioRxiv](http://biorxiv.org/content/early/2016/09/11/074625)
111+
- [v1.0](https://github.com/MobleyLab/benchmarksets/releases/tag/v1.0): As posted to [bioRxiv](http://biorxiv.org/content/early/2016/09/11/074625)
100112
- v1.0.1 ([10.5281/zenodo.155330](https://doi.org/10.5281/zenodo.15533)): Incorporating improved tables and typo fixes from D. Slochower; also, versions now have unique DOIs via Zenodo.
101113
- v1.0.4 ([10.5281/zenodo.167349](http://doi.org/10.5281/zenodo.167349)): Maintenance version fixing an incorrect PDB code and adding a new reference and some new links.
102114
- v1.1 ([10.5281/zenodo.197428](http://doi.org/10.5281/zenodo.197428)): Adds significant additional discussion on potential future benchmark sets, needs for workflow science, etc. See release notes for more details. Versions also now include the date and version number within the PDF.
103115
- v1.1.1 ([10.5281/zenodo.254619](http://doi.org/10.5281/zenodo.254619)): Adds input files for host-guest benchmarks; some revisions to text as recommended by Annual Reviews. See release notes for more details.
104116
- v1.1.2 ([10.5281/zenodo.569575](http://doi.org/10.5281/zenodo.569575)): Adds consistently handled SMILES for aromatics, Annual Reviews copyright/rights info in TeX and README, additional citation information for one reference, and new discussion of some new bromodomain absolute binding free energy work.
105117
- v1.1.3 ([10.5281/zenodo.571227](http://doi.org/10.5281/zenodo.571227)): Changes title to include "(a perpetual review)" to make more clear that this is not the same paper as the Annual Reviews version; makes clarifications to README.md about which version is which.
106-
- v1.1.4 ([10.5281/zenodo.838361](http://doi.org/10.5281/zenodo.838361)): Updates README.md to reflect publication; clarify differences in material; reflect availability on eScholarship. Updates paper to reflect migration to eScholarship rather than bioRxiv.
118+
- v1.1.4 ([10.5281/zenodo.838361](http://doi.org/10.5281/zenodo.838361)): Updates README.md to reflect publication; clarify differences in material; reflect availability on eScholarship. Updates paper to reflect migration to eScholarship rather than bioRxiv.
107119
- v1.2 ([10.5281/zenodo.839047](http://doi.org/10.5281/zenodo.839047)): Addition of bromodomain BRD4(1) test cases as a new ``soft'' benchmark, with help from Germano Heinzelmann. Addition of Heinzelmann as an author. Addition of files for BRD4(1) benchmark. Removed bromodomain material from future benchmarks in view of its presence now as a benchmark system.
108120
- v1.3: Include cyclodextrin benchmarks to data and to paper; removal of most of cyclodextrin material from future benchmarks. Addition of Niel Henriksen as an author based on his work on this. BRD4(1) changes: Reorganize data files; improve BRD4(1) README; switch sd to sdf files; give each BRD4(1) ligand a unique identifier specific to this paper.
109121

110122
## Changes not yet in a release
123+
- Add info on how to cite this paper to main README.md
111124

112125
## Manifest
113126

114-
* paper: Provides LaTeX source files and final PDF for the current version of the manuscript (reformatted and expanded from the version submitted to Ann. Rev. and with 2D structures added to the tables); images, etc. are also available in sub-directories, as is the supporting information.
115-
* input_files: Ultimately to include structures and simulation input files for all of the benchmark systems present as well as (we hope) gold standard calculated values for these files. Currently this includes:
116-
* README.md: A more extensive document describing the files present
127+
* `paper`: Provides LaTeX source files and final PDF for the current version of the manuscript (reformatted and expanded from the version submitted to Ann. Rev. and with 2D structures added to the tables); images, etc. are also available in sub-directories, as is the supporting information.
128+
* `input_files`: Ultimately to include structures and simulation input files for all of the benchmark systems present as well as (we hope) gold standard calculated values for these files. Currently this includes:
129+
* `README.md`: A more extensive document describing the files present
117130
* BRD4 structures and simulation input files from Germano Heinzelmann
118131
* CB7 structures and simulation input files from Jian Yin (Gilson lab)
119132
* GDCC structures and simulation input files from Jian Yin (Gilson lab)

0 commit comments

Comments
 (0)