Skip to content

Commit fa45247

Browse files
authored
Update README.md
Add collaborators, add preprint, reorganize
1 parent 339b806 commit fa45247

File tree

1 file changed

+29
-28
lines changed

1 file changed

+29
-28
lines changed

README.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,15 @@
11
# BenchmarkFF
22
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/vtlim/benchmarkff.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/vtlim/benchmarkff/context:python)
33

4-
README last updated: Aug 2 2020
4+
README last updated: Sep 27 2020
55

66
## About
77

8-
Overview: Compare optimized geometries and energies from various force fields with respect to a QM reference.
8+
**Objective**: Compare optimized geometries and energies from various force fields with respect to a QM reference.
99

1010
This repository comprises code to extract molecule datasets from [QCArchive](https://qcarchive.molssi.org/), run energy minimizations with various force fields, and analyze the resulting geometries and energies with respect to QM reference data from QCArchive.
1111

12-
## Python setup
13-
14-
### Package dependencies
15-
16-
* numpy, matplotlib, seaborn
17-
* OpenEye
18-
* RDKit (solely for TFD calculations)
19-
* OpenMM
20-
* OpenForceField
21-
* QCFractal, QCPortal
22-
23-
24-
### Conda setup
25-
```
26-
conda create -n parsley python=3.6 matplotlib numpy seaborn
27-
conda activate parsley
28-
conda install -c openeye -c conda-forge -c omnia rdkit openeye-toolkits qcfractal qcportal openforcefield cmiles openmm
29-
```
30-
31-
The packages in VTL's conda environment is documented in this repo as `parsley.yml`.
12+
See our work in this [preprint](https://chemrxiv.org/articles/preprint/Benchmark_Assessment_of_Molecular_Geometries_and_Energies_from_Small_Molecule_Force_Fields/12551867): Lim et. al.; Benchmark Assessment of Molecular Geometries and Energies from Small Molecule Force Fields. 2020.
3213

3314
## Contents
3415

@@ -55,8 +36,28 @@ File descriptions:
5536
|`03_analysis`|`reader.py` |reader for molecule sets and text input files called by the other analysis scripts|
5637
|`03_analysis`|`tailed_parameters.py` |identify parameters that may be overrepresented in high RMSD/TFD tails for FFXML force fields|
5738

39+
## Python setup
40+
41+
### Package dependencies
42+
43+
* numpy, matplotlib, seaborn
44+
* OpenEye
45+
* RDKit (solely for TFD calculations)
46+
* OpenMM
47+
* OpenForceField
48+
* QCFractal, QCPortal
49+
50+
51+
### Conda setup
52+
```
53+
conda create -n parsley python=3.6 matplotlib numpy seaborn
54+
conda activate parsley
55+
conda install -c openeye -c conda-forge -c omnia rdkit openeye-toolkits qcfractal qcportal openforcefield cmiles openmm
56+
```
57+
58+
The packages in VTL's conda environment is documented in this repo as `parsley.yml`.
5859

59-
## Brief overview
60+
## Brief overview of usage
6061

6162
### Setup
6263
1. Write out from a QCArchive database which have completed QM calculations, using `extract_qcarchive_dataset.ipynb`.
@@ -91,13 +92,13 @@ To explore the analyzed data, adjust plots, etc. without re-analyzing data, you
9192
input the pickle file written out from the previously run analysis.
9293

9394
## Contributors
94-
* Victoria Lim (author)
95-
* David Mobley (advising)
96-
* Jeffrey Wagner, Daniel Smith (code review)
97-
* Jessica Maat, Caitlin Bannan, Hyesu Jang, Lee-Ping Wang, Chris Bayly (discussions)
95+
* **Authors**: Victoria T. Lim, David F. Hahn
96+
* **Advising**: David Mobley, Gary Tresadern, Chris Bayly
97+
* **Code review**: Jeffrey Wagner, Daniel Smith
98+
* **Discussions**: Jessica Maat, Caitlin Bannan, Hyesu Jang, Lee-Ping Wang
9899

99100
## Big picture wish list / to do tasks
100-
See more science-focused issues in the Github issue tracker.
101+
See more focused issues in the [issue tracker](https://github.com/MobleyLab/benchmarkff/issues).
101102
* Format code with YAPF/Black
102103
* Use logging module instead of print statements
103104
* Look into automatically serializable representations (e.g., Pydantic) instead of pickle

0 commit comments

Comments
 (0)