Student or educator? Sign up with your school email and get 6 months of Pro free.

The DOI matches its Crossref record; 30 of the 30 references it cites were found in a registry or an index.

gmxapi: A GROMACS-native Python interface for molecular dynamics with ensemble and plugin support

Open access
Irrgang, M. Eric, Davis, Caroline, Kasson, Peter M. · 2022 · PLOS Computational Biology

Published version of a preprint

Abstract

Gmxapi provides an integrated, native Python API for both standard and advanced molecular dynamics simulations in GROMACS. The Python interface permits multiple levels of integration with the core GROMACS libraries, and legacy support is provided via an interface that mimics the command-line syntax, so that all GROMACS commands are fully available. Gmxapi has been officially supported since the GROMACS 2019 release and is enabled by default in current versions of the software. Here we describe gmxapi 0.3 and later. Beyond simply wrapping GROMACS library operations, the API permits several advanced operations that are not feasible using the prior command-line interface. First, the API allows custom user plugin code within the molecular dynamics force calculations, so users can execute custom algorithms without modifying the GROMACS source. Second, the Python interface allows tasks to be dynamically defined, so high-level algorithms for molecular dynamics simulation and analysis can be coordinated with loop and conditional operations. Gmxapi makes GROMACS more accessible to custom Python scripting while also providing support for high-level data-flow simulation algorithms that were previously feasible only in external packages.

Overview

The claims and statistics of this paper haven’t been checked yet.

Run the check — free, no account needed. It reads the open-access text and checks the sources it cites.

A few free checks a day · papers already verified open instantly · results are public

Integrity signals

Registry

Crossref · 10.1371/journal.pcbi.1009835

Cites

30 of 30 references verified0 citation errors · 0 not checkable

Statistics

Figures

Fig 1 gmxapi usage examples. Panel (A) shows an example of the commandline_operation function by which gmxapi can reproduce any GROMACS functionality. Panel (B) shows gmxapi molecular dynamics calls operating on ensemble input, providing straightforward high-level parallelism in addition to parallelization within each command. Panel (C) demonstrates both a while loop and pluggability of gmxapi components. Together, the examples will execute an ensemble of small protein folding simulations until at least one ensemble member samples the native state.
Fig 1 gmxapi usage examples. Panel (A) shows an example of the commandline_operation function by which gmxapi can reproduce any GROMACS functionality. Panel (B) shows gmxapi molecular dynamics calls operating on ensemble input, providing straightforward high-level parallelism in addition to parallelization within each command. Panel (C) demonstrates both a while loop and pluggability of gmxapi components. Together, the examples will execute an ensemble of small protein folding simulations until at least one ensemble member samples the native state.CC BY · PubMed Central
Fig 2 Schematic of data flow and control flow for a segment of a complex simulation workflow. Ensembles of simulations can be run (denoted by stacked rectangles) by gmxapi merely by passing an array of inputs instead of a single input. Custom plugins can interact with running MD simulations. Finally, conditional and looping logic can create high-level simulation algorithms.
Fig 2 Schematic of data flow and control flow for a segment of a complex simulation workflow. Ensembles of simulations can be run (denoted by stacked rectangles) by gmxapi merely by passing an array of inputs instead of a single input. Custom plugins can interact with running MD simulations. Finally, conditional and looping logic can create high-level simulation algorithms.CC BY · PubMed Central
Fig 3 Schematics for gmxapi operations. As shown in panel (A), gmxapi operations have well defined inputs and outputs. These can operate on arrays of inputs and also include support for legacy GROMACS operations by wrapping the command-line toolset, as shown in panel (B). As shown in panel (C), the decorator @function_wrapper allows arbitrary user code to be transformed into a gmxapi operation.
Fig 3 Schematics for gmxapi operations. As shown in panel (A), gmxapi operations have well defined inputs and outputs. These can operate on arrays of inputs and also include support for legacy GROMACS operations by wrapping the command-line toolset, as shown in panel (B). As shown in panel (C), the decorator @function_wrapper allows arbitrary user code to be transformed into a gmxapi operation.CC BY · PubMed Central
Fig 4 Detailed diagram of inputs, outputs, and operations in a chain of gmxapi operations. Operations are shown in green boxes, the corresponding nodes in the work graph in red boxes, inputs in orange boxes, and outputs in blue boxes. The diagram depicts a chain of GROMACS tools preparing simulation input, feeding into "gmxapi.mdrun" to run a batch of simulations.
Fig 4 Detailed diagram of inputs, outputs, and operations in a chain of gmxapi operations. Operations are shown in green boxes, the corresponding nodes in the work graph in red boxes, inputs in orange boxes, and outputs in blue boxes. The diagram depicts a chain of GROMACS tools preparing simulation input, feeding into "gmxapi.mdrun" to run a batch of simulations.CC BY · PubMed Central
Fig 5 Residue-residue distance distributions in a simulated ensemble of HIV gp41. DEER spectroscopy was used to measure distance distributions between two monomers of the gp41 trimer. Thus, each residue designates a monomer-monomer residue pair. Panels A-E show plots for the 5 restrained residues in the HIV trimer: 106, 173, 202, 306, and 542 respectively. Discretized DEER distance distributions are plotted in green, and simulation results are plotted in blue bars. The simulation ensemble shows good convergence to the measured values.
Fig 5 Residue-residue distance distributions in a simulated ensemble of HIV gp41. DEER spectroscopy was used to measure distance distributions between two monomers of the gp41 trimer. Thus, each residue designates a monomer-monomer residue pair. Panels A-E show plots for the 5 restrained residues in the HIV trimer: 106, 173, 202, 306, and 542 respectively. Discretized DEER distance distributions are plotted in green, and simulation results are plotted in blue bars. The simulation ensemble shows good convergence to the measured values.CC BY · PubMed Central

Verification

Claims the paper makes

The claims and statistics of this paper haven’t been checked yet.

Run the check — free, no account needed. It reads the open-access text and checks the sources it cites.

A few free checks a day · papers already verified open instantly · results are public

Self-check

Percentages, sums and reported differences re-computed from the paper’s own numbers.

The self-check needs the paper’s full text.

Citations

Cites

Show all 30 references

Metadata

Authors
Irrgang, M. E., Davis, C., & Kasson, P. M.
Affiliations
  • University of Virginia (US)
  • Uppsala University (SE)
Corresponding author
Kasson, Peter M.
Venue
PLOS Computational Biology
Published
2022-02-14
Volume
18
Issue
2
Pages
e1009835
ISSN
  • 1553-734X (ISSN-L)
  • 1553-7358
OpenAlex
W4221099088
Cited by
25
References
30
Citations by year
2026: 7 · 2025: 11 · 2024: 4 · 2023: 3
FWCI
1.47
Type
journal article
Language
en
Open access
Locations
  • PLoS Computational Biology (publishedVersion, cc-by)
  • bioRxiv (Cold Spring Harbor Laboratory) (acceptedVersion, cc-by-nc-nd)
  • PubMed Central (publishedVersion, cc-by)
  • PubMed (publishedVersion)
  • Uppsala University Publications (Uppsala University) (submittedVersion, other-oa)
  • RePEc: Research Papers in Economics (submittedVersion)
  • DOAJ (DOAJ: Directory of Open Access Journals) (submittedVersion, cc-by-sa)
Funders
  • national institute of general medical sciences (R01 GM115790)
  • national science foundation (OAC-1835780, ACI-1547580, LRAC MCB20006)
Topics
  • Life Sciences › Biochemistry, Genetics and Molecular Biology › Molecular Biology › Protein Structure and Dynamics
  • Physical Sciences › Computer Science › Software › Computational Physics and Python Applications
  • Physical Sciences › Chemistry › Physical and Theoretical Chemistry › Advanced Physical and Chemical Molecular Interactions
Keywords
GROMACS, Python interface, molecular dynamics simulation, ensemble simulation, Python scripting
MeSH terms
Algorithms, Software, Molecular Dynamics Simulation

About these checks

Registry, retraction, Cites and statistics results are computed, not judged, with one exception: a printed reference that no index lists is read once by a model before it counts as a citation error. Claims are extracted by a model and kept only when their quote appears verbatim in the text; each cited source is then checked, with a model’s help, for whether it says what the claim relies on. Those verdicts can be wrong — read the claim’s quote and the cited source before relying on one.

Statistics and arithmetic are recomputed, not judged.

Confidence bands are shown only for fields calibrated on our annotated test set. None is calibrated yet, so no band is shown.

What counts as a claim ›How we measure confidence ›How we check this ›

Are you an author, or do you see a problem with this page? Request a review

How to cite

Cite CoChat for the checks on this page, and the paper for its own findings.

This page
CoChat. (2026). Citation check: gmxapi: A GROMACS-native Python interface for molecular dynamics with ensemble and plugin support. https://app.cochat.ai/papers/10.1371/journal.pcbi.1009835
The paper
Irrgang, M. E., Davis, C., & Kasson, P. M. (2022). gmxapi: A GROMACS-native Python interface for molecular dynamics with ensemble and plugin support. PLOS Computational Biology. https://doi.org/10.1371/journal.pcbi.1009835

Data sources

Bibliographic data: Semantic Scholar, OpenAlex, Crossref.

Contains information from the Semantic Scholar Academic Graph Datasets, made available under the ODC Attribution License (ODC-BY 1.0).

Semantic Scholar’s data is described in: Kinney, R., et al. (2023). The Semantic Scholar Open Data Platform. arXiv:2301.10140.