Skip to main content

A python wrapper around the Gromacs tools.

Project description

Build Status Code Coverage Documentation Latest release on zenodo (with DOI) PRs Welcome!

A primitive Python wrapper around the Gromacs tools. The library is tested with Gromacs 4.6.5, 2018.x, 2019.x (and 2016.x also works) and is tested with Python 2.7 and 3.6.

GromacsWrapper also provides a small library (cook book) of often-used recipes and helper functions to set up MD simulations.

Documentation is mostly provided through the python doc strings and available at for recent releases.

The source code is available in the GromacsWrapper git repository.

Please be aware that this is beta software that most definitely contains bugs. It is your responsibility to ensure that you are running simulations with sensible parameters.

Quick Start

Given a PDB file 1iee.pdb, set up and run a simple simulation (assuming you have all other input files at hand such as the MDP files):

>>> import gromacs
>>> print(gromacs.release)
>>> help(gromacs.pdb2gmx)

gmx pdb2gmx reads a .pdb (or .gro) file, reads some database files,
adds hydrogens to the molecules and generates coordinates in GROMACS

Options to specify input files:

-f      [<.gro/.g96/...>]  (eiwit.pdb)
          Structure file: gro g96 pdb brk ent esp tpr
>>> gromacs.pdb2gmx(f="1ake.pdb", o="protein.gro", p="",
...                 ff="oplsaa", water="tip4p")
>>> gromacs.editconf(f="protein.gro", o="boxed.gro",
...                  bt="dodecahedron", d=1.5, princ=True,
...                  input="Protein")
>>> gromacs.solvate(cp="boxed.gro", cs="tip4p", p="",
...                 o="solvated.gro")
>>> gromacs.grompp(f="emin.mdp", c="solvated.gro", p="",
...                o="emin.tpr")
>>> gromacs.mdrun(v=True, deffnm="emin")
>>> gromacs.grompp(f="md.mdp", c="md.gro", p="", o="md.tpr")
>>> gromacs.mdrun(v=True, deffnm="md")


The GromacsWrapper package is made available under the terms of the GNU Public License v3 (or any higher version at your choice) except as noted below. See the file COPYING for the licensing terms for all modules.

The distribution contains third party software that is copyrighted by the authors but distributed under licences compatible with this package license. Where permitted and necessary, software/files were modified to integrate with GromacsWrapper.



The latest version of GromacsWrapper from PyPi and can be installed with

pip install GromacsWrapper

Development version

The master branch in the GitHub source repository generally contains useful code but nevertheless, things can break in weird and wonderful ways. Please report issues through the Issue Tracker and mention that you used the develop branch.

To use the development code base: checkout the master branch:

git clone
cd GromacsWrapper

and install

python install

Download and Availability

The GromacsWrapper home page is The latest release of the package is being made available from

You can also clone the GromacsWrapper git repository or fork for your own development:

git clone git://


Please ask questions in the Issue Tracker (instead of private email).

Reporting Bugs and Contributing to GromacsWrapper

Please use the Issue Tracker to report bugs, installation problems, and feature requests.

Pull requests for bug fixes and enhancements are very welcome. See for a general introduction on how make a pull request and contribute to open source projects.

Building Documentation

Install Sphinx:

pip install sphinx

and compile:

cd package/doc/sphinx
make html


Latest release on zenodo (with DOI)

GromacsWrapper was written by Oliver Beckstein with contributions from many other people. Please see the file AUTHORS for all the names.

If you find this package useful and use it in published work I’d be grateful if it was acknowledged in text as

“… used GromacsWrapper (Oliver Beckstein et al, doi: 10.5281/zenodo.17901)”

or in the Acknowledgements section.

Thank you.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for GromacsWrapper, version 0.8.0
Filename, size & hash File type Python version Upload date
GromacsWrapper-0.8.0-py2.py3-none-any.whl (645.0 kB) View hashes Wheel py2.py3
GromacsWrapper-0.8.0.tar.gz (177.8 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page