MoSDeF-dihedral-fit

MoSDeF-dihedral-fit: A lightweight software for fitting dihedrals within MoSDeF - Published in JOSS (2024)

https://github.com/gomc-wsu/mosdef-dihedral-fit

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: acs.org
  • Committers with academic emails
    2 of 6 committers (33.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation ·

Repository

MoSDeF-dihedral-fit: A simple software package to fit dihedrals via the MoSDeF software

Basic Info
  • Host: GitHub
  • Owner: GOMC-WSU
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 2.46 MB
Statistics
  • Stars: 3
  • Watchers: 4
  • Forks: 6
  • Open Issues: 2
  • Releases: 17
Created about 3 years ago · Last pushed 7 months ago
Metadata Files
Readme Contributing License Citation

README.md

pre-commit.ci status CI

MoSDeF-dihedral-fit

The MoSDeF-dihedral-fit: an open-source, transparent, and lightweight Python software package capable of fitting dihedrals with QM calculations for existing forces fields. This software fits the Optimized Potentials for Liquid Simulations (OPLS) style dihedrals, then also analytically converts them to the periodic dihedral and Ryckaert-Bellemans (RB) torsion.

python import unyt as u from mosdef_dihedral_fit.dihedral_fit.fit_dihedral_with_gomc import fit_dihedral_with_gomc fit_dihedral_with_gomc( ["HC", "CT", "CT", "HC"], #atomclass names of the dihedral "molecule.mol2" # mol2 file with relevant structure "compound.xml", # xml file with other atomtyped parameters in foyer format 298.15 * u.Kelvin, # relevant temperature gomc_binary_directory, # path to binary command from GOMC install {"HC_CT_CT_HC_multiplicity_1.log": []}, # log file to store info zero_dihedral_atom_types=None, qm_engine="gaussian", combining_rule='lorentz', atom_type_naming_style='general', gomc_cpu_cores=1, r_squared_min=0.99, r_squared_atol=1e-03, opls_force_k0_zero=True ) import os os.system("cat RB_torsion_k_constants_fit_energy.txt") os.system("cat opls_torsion_k_constants_fit_energy.txt") os.system("cat periodic_torsion_k_constants_fit_energy.txt")

The plotted dihedral fits:

- "opls_all_single_fit_dihedral_k_constants_figure.pdf"
- "opls_all_summed_dihedrals_k_constants_figure.pdf"

Quick Installation/Setup

Note the mamba is used as a drop-in replacement for conda in the below installation, but conda works as well. bash mamba install -c conda-forge mosdef-dihedral-fit conda activate mosdef-dihedral-fit cd $CONDA_PREFIX git clone https://github.com/GOMC-WSU/GOMC.git --branch v2.75a cd GOMC chmod u+x metamake.sh NVT ./metamake.sh ln -s $CONDA_PREFIX/GOMC/bin/GOMC_CPU_NVT $CONDA_PREFIX/bin

GOMC will also be removed when the mosdefdihedralfit environment is removed. The installation can be placed anywhere though, that path will just have to manually be passed for the variable gomcbinarydirectory.

More setup information

For more complete setup information see the full installation documentation

Documentation

The MoSDeF-dihedral-fit documentation can be found here.

Dihedral Equations

OPLS-dihedral:

$$U{OPLS} = \frac{k0}{2}$$

$$+ \frac{k1}{2} * (1 + cos(\theta)) + \frac{k2}{2} * (1-cos(2 * \theta))$$

$$+ \frac{k3}{2} * (1 + cos(3 * \theta)) + \frac{k4}{2} *(1-cos(4 * \theta))$$

Ryckaert-Bellemans (RB)-torsions:

$$U{RB} = C0$$

$$+ C1 * cos(\psi) + C2 * cos(\psi)^2$$

$$+ C3 * cos(\psi)^3 + C4 * cos(\psi)^4$$

$$\psi = \theta - 180^o$$

Periodic-dihedral:

$$U{Periodic} = K0 * (1 + cos(n0*\theta - d0))$$

$$+ K1 * (1 + cos(n1\theta - d1)) + K2 * (1 + cos(n_2\theta - d_2))$$

$$+ K3 * (1 + cos(n3\theta - d3)) + K4 * (1 + cos(n_4\theta) - d_4)$$

$$where: n0 = 0 ; n1 = 1 ; n2 = 2 ; n3 = 3 ; n_4 = 4 $$

$$d0 = 90^o ; d1 = 180^o ; d2 = 0^o ; d3 = 180^o ; d_4 = 0^o$$

Examples

Some basic workflows that use this package and cover several force field (FF) types are here. A summary of the FFs covered in the examples are listed below.

  • OPLS-AA: ethane dihedral
  • OPLS-AA: propanoic acid dihedral
  • AMBER-AA: butane dihedral
  • TraPPE-UA: butane dihedral
  • Mie-UA: butane dihedral
  • Exp6-AA: butane dihedral

Resources

This package is made as an API with MoSDeF and MoSDeF-GOMC. For mosdef_dihedral_fit to function, the forcefield files must be in a supported MoSDeF format (preferably the GMSO force field format), and use MoSDeF-GOMC and GOMC to perform the simulation setup and simulations.

Citations

  • Please cite MoSDeF-GOMC here
  • Other tools used in this package can be found in the MoSDeF-Dihedral-Fit documentation.

Owner

  • Name: GOMC
  • Login: GOMC-WSU
  • Kind: user
  • Location: Detroit, MI, USA
  • Company: Wayne State University

JOSS Publication

MoSDeF-dihedral-fit: A lightweight software for fitting dihedrals within MoSDeF
Published
December 06, 2024
Volume 9, Issue 104, Page 6970
Authors
Brad Crawford ORCID
Atomfold, PA, United States of America, Department of Chemical Engineering and Materials Science, Wayne State University, Detroit, MI 48202-4050, United States of America
Co D. Quach ORCID
Department of Chemical and Biomolecular Engineering, Vanderbilt University, Nashville, TN 37235-1604, United States of America, Multiscale Modeling and Simulation (MuMS) Center, Vanderbilt University, Nashville, TN 37212, United States of America
Nicholas C. Craven ORCID
Multiscale Modeling and Simulation (MuMS) Center, Vanderbilt University, Nashville, TN 37212, United States of America, Interdisciplinary Material Science Program, Vanderbilt University, Nashville, TN 37235-0106, United States of America
Christopher R. Iacovella ORCID
Department of Chemical and Biomolecular Engineering, Vanderbilt University, Nashville, TN 37235-1604, United States of America, Multiscale Modeling and Simulation (MuMS) Center, Vanderbilt University, Nashville, TN 37212, United States of America, Interdisciplinary Material Science Program, Vanderbilt University, Nashville, TN 37235-0106, United States of America
Clare McCabe ORCID
Department of Chemical and Biomolecular Engineering, Vanderbilt University, Nashville, TN 37235-1604, United States of America, Multiscale Modeling and Simulation (MuMS) Center, Vanderbilt University, Nashville, TN 37212, United States of America, School of Engineering and Physical Sciences, Heriot-Watt University, Edinburgh EH14 4AS, United Kingdom
Peter T. Cummings ORCID
Department of Chemical and Biomolecular Engineering, Vanderbilt University, Nashville, TN 37235-1604, United States of America, Multiscale Modeling and Simulation (MuMS) Center, Vanderbilt University, Nashville, TN 37212, United States of America, School of Engineering and Physical Sciences, Heriot-Watt University, Edinburgh EH14 4AS, United Kingdom
Jeffrey J. Potoff ORCID
Department of Chemical Engineering and Materials Science, Wayne State University, Detroit, MI 48202-4050, United States of America
Editor
Sophie Beck ORCID
Tags
Molecular simulations Molecular mechanics Molecular dynamics Monte Carlo Quantum mechanics dihedral fitting torsion fitting force field MoSDeF GOMC MoSDeF-GOMC

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.0.0
title: "MoSDeF-dihedral-fit"
message: "Please cite this software using these metadata and the preferred citation."
type: software
authors:
  - given-names: "Brad"
    family-names: Crawford
    affiliation: "Atomfold"
    orcid: 'https://orcid.org/0000-0003-0638-7333'
  - given-names: "Co D."
    family-names: Quach
    affiliation: "Vanderbilt University"
    orcid: 'https://orcid.org/0000-0002-1255-4161'
  - given-names: "Nicholas"
    family-names: Craven
    affiliation: "Vanderbilt University"
    orcid: 'https://orcid.org/0000-0002-4607-4377'
  - given-names: "Christopher R."
    family-names: Iacovella
    affiliation: "Vanderbilt University"
    orcid: 'https://orcid.org/0000-0003-0557-0427'
  - given-names: "Clare"
    family-names: McCabe
    affiliation: "Heriot-Watt University"
    orcid: 'https://orcid.org/0000-0002-8552-9135'
  - given-names: "Peter T."
    family-names: Cummings
    affiliation: "Heriot-Watt University"
    orcid: 'https://orcid.org/0000-0002-9766-2216'
  - given-names: "Jeffrey"
    family-names: Potoff
    affiliation: "Wayne State University"
    orcid: 'https://orcid.org/0000-0002-4421-8787'

repository-code: 'https://github.com/GOMC-WSU'
url: 'https://github.com/GOMC-WSU'
repository: 'https://github.com/GOMC-WSU/MoSDeF-dihedral-fit'
repository-artifact: 'https://github.com/GOMC-WSU/MoSDeF-dihedral-fit/releases'
abstract: MoSDeF-dihedral-fit

keywords:
  - Python
  - Reproducibility
  - "Molecular Simulation"
  - "Monte Carlo"
  - "dihedral"
  - "torsion"
  - GOMC
  - "computational chemistry"
  - chemistry
  - 'TRUE'
  - mosdef
license: "MIT"
preferred-citation:
  type: "article"
  authors:
  - given-names: "Brad"
    family-names: Crawford
    affiliation: "Atomfold"
    orcid: 'https://orcid.org/0000-0003-0638-7333'
  - given-names: "Co D."
    family-names: Quach
    affiliation: "Vanderbilt University"
    orcid: 'https://orcid.org/0000-0002-1255-4161'
  - given-names: "Nicholas"
    family-names: Craven
    affiliation: "Vanderbilt University"
    orcid: 'https://orcid.org/0000-0002-4607-4377'
  - given-names: "Christopher R."
    family-names: Iacovella
    affiliation: "Vanderbilt University"
    orcid: 'https://orcid.org/0000-0003-0557-0427'
  - given-names: "Clare"
    family-names: McCabe
    affiliation: "Heriot-Watt University"
    orcid: 'https://orcid.org/0000-0002-8552-9135'
  - given-names: "Peter T."
    family-names: Cummings
    affiliation: "Heriot-Watt University"
    orcid: 'https://orcid.org/0000-0002-9766-2216'
  - given-names: "Jeffrey"
    family-names: Potoff
    affiliation: "Wayne State University"
    orcid: 'https://orcid.org/0000-0002-4421-8787'
  title: "MoSDeF-dihedral-fit"
  year: "TBD"
  doi: "10.5281/zenodo.14107384"

GitHub Events

Total
  • Create event: 18
  • Commit comment event: 1
  • Issues event: 5
  • Release event: 8
  • Issue comment event: 5
  • Push event: 33
  • Pull request review event: 1
  • Pull request event: 32
  • Fork event: 1
Last Year
  • Create event: 18
  • Commit comment event: 1
  • Issues event: 5
  • Release event: 8
  • Issue comment event: 5
  • Push event: 33
  • Pull request review event: 1
  • Pull request event: 32
  • Fork event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 493
  • Total Committers: 6
  • Avg Commits per committer: 82.167
  • Development Distribution Score (DDS): 0.357
Past Year
  • Commits: 105
  • Committers: 5
  • Avg Commits per committer: 21.0
  • Development Distribution Score (DDS): 0.314
Top Committers
Name Email Commits
bc118 c****8@g****m 317
pre-commit-ci[bot] 6****] 77
Co Quach d****7@g****m 41
CalCraven n****n@v****u 35
Jeffrey Potoff j****f 12
GOMC g****c@e****u 11
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 14
  • Total pull requests: 110
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 4 days
  • Total issue authors: 3
  • Total pull request authors: 5
  • Average comments per issue: 1.64
  • Average comments per pull request: 0.21
  • Merged pull requests: 101
  • Bot issues: 0
  • Bot pull requests: 14
Past Year
  • Issues: 2
  • Pull requests: 30
  • Average time to close issues: 8 minutes
  • Average time to close pull requests: 4 days
  • Issue authors: 1
  • Pull request authors: 4
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.27
  • Merged pull requests: 24
  • Bot issues: 0
  • Bot pull requests: 6
Top Authors
Issue Authors
  • bc118 (7)
  • naik-aakash (6)
  • CalCraven (1)
  • RiesBen (1)
Pull Request Authors
  • bc118 (118)
  • pre-commit-ci[bot] (21)
  • daico007 (18)
  • jpotoff (4)
  • CalCraven (2)
Top Labels
Issue Labels
Pull Request Labels
enhancement (5) documentation (2)

Dependencies

.github/workflows/CI.yml actions
  • actions/checkout v2 composite
  • codecov/codecov-action v3 composite
  • conda-incubator/setup-miniconda v2 composite
  • docker/build-push-action v2 composite
  • docker/login-action v1 composite
  • docker/setup-buildx-action v1 composite
Dockerfile docker
  • continuumio/miniconda3 4.10.3-alpine build
docs/requirements.txt pypi
  • anaconda *
  • ele *
  • gsd *
  • ipykernel *
  • ipywidgets *
  • lark-parser *
  • mock *
  • nbsphinx *
  • numpydoc *
  • requests *
  • sphinx *
  • sphinx_rtd_theme *
  • sphinxcontrib *
  • sphinxcontrib-svg2pdfconverter *
  • sphinxcontrib-video *
  • unyt *
  • widgetsnbextension *
setup.py pypi
environment.yml conda
  • ipython
  • mock
  • mosdef-gomc
  • nbsphinx
  • numpydoc
  • pip
  • pre-commit
  • pycifrw
  • pydantic 1.10.10.*
  • pytest
  • pytest-cov
  • python >=3.9,<=3.10
  • sphinx 6.1.1.*
  • sphinx_rtd_theme
  • sphinxcontrib
  • vmd-python