gromacs-osc

Modifications to GROMACS 2021.5 to perform MD simulations in the presence of Ultrasounds

https://github.com/allexandre97/gromacs-osc

Science Score: 54.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
  • Academic publication links
    Links to: sciencedirect.com
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.5%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Modifications to GROMACS 2021.5 to perform MD simulations in the presence of Ultrasounds

Basic Info
  • Host: GitHub
  • Owner: allexandre97
  • License: lgpl-2.1
  • Language: C++
  • Default Branch: main
  • Homepage:
  • Size: 77.3 MB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

GROMACS-OSC

Modifications to GROMACS 2021.5 to perform MD simulations in the presence of Ultrasounds. Used in the work Molecular insights into the effects of focused ultrasound mechanotherapy on lipid bilayers: Unlocking the keys to design effective treatments

Implementation

The specific, in-detail, implementation of the ultrasound wave can be consulted at the aforementioned paper. Here just a quick overview is given:

In general, barostats are pressure-control algorithms that are commonly used in MD to maintain an averagely constant (fluctuations are permitted) pressure throughout a simulation. These algorithms take, fundamentally, a mathematical form, being a function of several variables. One of these variables is the target pressure that is want to be kept in the simulation. Adding a simple oscillatory term to this target pressure, for example in the form of a sine wave, has the effect of inducing an oscillating pressure in the system, this is, a sound wave.

How to compile the code

So far the implementation is not elegant nor optimal. The code needs to be recompiled each time a different ultrasound (i.e. different frequency or overpressure) wants to be tested. For that, I provide a bash wrapper file that handles the compilation automatically. You simply clone the repository in the machine you want to run the simulation in and call

./compile_gromcs.sh -f <frequency> -a <amplitude> -p <install_path> -j <jobs>

This will compile a GROMACS version in the specified path with a modified Berendsen barostat ready to produce simulations in the presence of an ultrasound of the specified frequency and overpressure/amplitude.

Beware, this wrapper was built to be used in the HPC environment where I carried my PhD (the Centro de Supercomputación de Galicia), which uses SLURM to handle the loading of libraries and modules. Therefore, you will most likely need to modify the wrapper to accommodate any differences with the environment you will be working on.

If your environment also uses SLURM

If this is the case, you will need to modify the line module load [...] with the corresponding modules of your environment in order to have a working GROMACS install.

If your environment does NOT use SLURM

You can completely remove the module load [...] line. You have to make sure, then, that your machine has the compiler tools needed to build GROMACS 2025. If you plan to use MPI parallelization, that means that you will need cmake and mpicc. If you are not using MPI, you can still use cmake with gcc/g++.

How to cite

If you use this code for any work or publication, please cite:

  • Blanco-González, A., Marrink, S. J., Piñeiro, Á., & García-Fandiño, R. (2023). Molecular insights into the effects of focused ultrasound mechanotherapy on lipid bilayers: Unlocking the keys to design effective treatments. Journal of Colloid and Interface Science, 650, 1201-1210.
  • Blanco-González, A. (2023), GROMACS-OSC [Software]. GitHub: https://github.com/allexandre97/GROMACS-OSC

Of course, please also cite the original GROMACS code!

Owner

  • Name: Alexandre Blanco
  • Login: allexandre97
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Blanco-González
    given-names: Alexandre
    orcid: https://orcid.org/0000-0001-8593-5881
title: "GROMACS-OSC"
version: 1.0

GitHub Events

Total
  • Watch event: 1
  • Push event: 4
Last Year
  • Watch event: 1
  • Push event: 4

Dependencies

gromacs-osc/python_packaging/sample_restraint/Dockerfile docker
  • gmxapi/gmxapi 0.0.7 build
gromacs-osc/python_packaging/requirements-docs.txt pypi
  • Pygments >=2.2.0
  • Sphinx >=1.6.3
  • sphinxcontrib-plantuml >=0.14
gromacs-osc/python_packaging/requirements-test.txt pypi
  • cmake >=3.13 test
  • flake8 >=3.7.7 test
  • mpi4py >=3.0.3 test
  • networkx >=2.0 test
  • numpy >=1 test
  • pip >=10.1 test
  • pytest >=3.9 test
  • scikit-build >=0.10 test
  • setuptools >=42 test
  • wheel * test
gromacs-osc/python_packaging/src/pyproject.toml pypi
gromacs-osc/python_packaging/src/requirements.txt pypi
  • cmake >=3.13
  • networkx >=2.0
  • numpy >=1
  • pip >=10.1
  • scikit-build >=0.10
  • setuptools >=42
  • wheel *
gromacs-osc/python_packaging/src/setup.py pypi
  • networkx >=2.0
  • numpy >=1