 |
 |
 |
| |
|
|
PLUMED is a plugin that works with a large number of molecular dynamics codes (Codes interfaced with PLUMED ). It can be used to analyze features of the dynamics on-the-fly or to perform a wide variety of free energy methods. PLUMED can also work as a Command Line Tools to perform analysis on trajectories saved in most of the existing formats. If PLUMED is useful for your work please read and cite [106], if you are interested in the PLUMED 1 original publication please read and cite [20] .
To follow the development of PLUMED 2, you can look at the detailed Change Log .
To install PLUMED, see this page: Installation , while in Getting Started you can find a brief introduction on how to write your first PLUMED input file.
tutorials are available to introduce basic as well as more advanced features of PLUMED.
This manual has been compiled from PLUMED version 2.10.2 (git version: 90dec6d ). Manual built on GitHub Actions on ref refs/heads/v2.10.
This is the user manual - if you want to modify PLUMED or to understand how it works internally, have a look at the developer manual .
An experimental PDF copy of this manual can be found here, but the html documentation should be considered as the official one. The PDF version has some known issue (e.g. some links are not working properly and images are not correctly included). The goal of the PDF manual is to allow people to download a full copy on the documentation for offline access and to perform easily full-text searches. Notice that the manual is updated very frequently (sometime more than once per week), so keep your local version of the PDF manual up to date. Since the PDF manual is 200+ pages and is continuously updated, please do not print it!
PLUMED can be incorporated into an MD code and used to analyze or bias a molecular dynamics run on the fly. Some MD code could already include calls to the PLUMED library and be PLUMED-ready in its original distribution. As far as we know, the following MD codes can be used with PLUMED out of the box:
Please refer to the documentation of the MD code to know how to use it with the latest PLUMED release. If you maintain another MD code that is PLUMED-ready let us know and we will add it to this list.
Additionally, we provide patching procedures for the following codes:
The patches for GROMACS 2025 and 2026 add features to the PLUMED interface that GROMACS includes since version 2025, and the patches for the older versions of GROMACS have some more:
| Feature | GROMACS 2025 or later, without patches | patches for GROMACS 2025 and 2026 | patches for GROMACS 2022 to 2024 |
|---|---|---|---|
| biases on atoms, with domain decomposition and multiple time stepping | yes (1) | yes | yes |
| ENERGY collective variable and biases on the energy | no | yes (2,3) | yes (3) |
multiple simulations that communicate through MPI (e.g. WALKERS_MPI) | no | yes | yes |
| PLUMED checkpoint data written at the steps of the GROMACS checkpoints | no | yes (2) | yes |
| PLUMED stopping the simulation (e.g. COMMITTOR) | no | yes | yes |
| polarizable models with shells | no | yes (4) | no |
replica exchange with a PLUMED bias (-replex, -hrex) | no | no | yes |
| lambda dynamics (expanded ensemble) | no | no | yes |
Notes on the table:
GMX_DISABLE_MODULAR_SIMULATOR=1.The interface with GROMACS is tested on the PLUMED testcenter.
Alternatively, one can use PLUMED as a Command Line Tools for post processing the results from molecular dynamics or enhanced sampling calculations. Notice that PLUMED can be used as an analysis tool also from the following packages:
1.13.2