Contents Menu Expand Light mode Dark mode Auto light/dark mode
GROMACS 2024.4 documentation
Logo
  • Downloads
  • Release notes
    • GROMACS 2024.4 release notes
    • GROMACS 2024.3 release notes
    • GROMACS 2024.2 release notes
    • GROMACS 2024.1 release notes
    • Highlights
    • New and improved features
    • Performance improvements
    • Changes to the API
    • Improvements to GROMACS tools
    • Bugs fixed
    • Deprecated functionality
    • Removed functionality
    • Portability
    • Miscellaneous
    • GROMACS 2023.6 release notes
    • GROMACS 2023.5 release notes
    • GROMACS 2023.4 release notes
    • GROMACS 2023.3 release notes
    • GROMACS 2023.2 release notes
    • GROMACS 2023.1 release notes
    • Highlights
    • New and improved features
    • Performance improvements
    • Changes to the API
    • Improvements to GROMACS tools
    • Bugs fixed
    • Deprecated functionality
    • Removed functionality
    • Portability
    • Miscellaneous
    • GROMACS 2022.6 release notes
    • GROMACS 2022.5 release notes
    • GROMACS 2022.4 release notes
    • GROMACS 2022.3 release notes
    • GROMACS 2022.2 release notes
    • GROMACS 2022.1 release notes
    • Highlights
    • New and improved features
    • Performance improvements
    • Changes to the API
    • Improvements to GROMACS tools
    • Bugs fixed
    • Deprecated functionality
    • Removed functionality
    • Portability
    • Miscellaneous
    • GROMACS 2021.7 release notes
    • GROMACS 2021.6 release notes
    • GROMACS 2021.5 release notes
    • GROMACS 2021.4 release notes
    • GROMACS 2021.3 release notes
    • GROMACS 2021.2 release notes
    • GROMACS 2021.1 release notes
    • Highlights
    • New and improved features
    • Performance improvements
    • Improvements to GROMACS tools
    • Bugs fixed
    • Deprecated functionality
    • Removed functionality
    • Portability
    • Miscellaneous
    • GROMACS 2020.7 release notes
    • GROMACS 2020.6 release notes
    • GROMACS 2020.5 release notes
    • GROMACS 2020.4 release notes
    • GROMACS 2020.3 release notes
    • GROMACS 2020.2 release notes
    • GROMACS 2020.1 release notes
    • Highlights
    • New and improved features
    • Performance improvements
    • Improvements to GROMACS tools
    • Bugs fixed
    • Deprecated functionality
    • Removed functionality
    • Portability
    • Miscellaneous
    • GROMACS 2019.6 release notes
    • GROMACS 2019.5 release notes
    • GROMACS 2019.4 release notes
    • GROMACS 2019.3 release notes
    • GROMACS 2019.2 release notes
    • GROMACS 2019.1 release notes
    • Highlights
    • New and improved features
    • Performance improvements
    • Improvements to GROMACS tools
    • Bugs fixed
    • Deprecated functionality
    • Removed functionality
    • Portability
    • Miscellaneous
    • GROMACS 2018.7 release notes
    • GROMACS 2018.6 release notes
    • GROMACS 2018.5 release notes
    • GROMACS 2018.4 release notes
    • GROMACS 2018.3 release notes
    • GROMACS 2018.2 release notes
    • GROMACS 2018.1 release notes
    • Highlights
    • New and improved features
    • Performance improvements
    • Improvements to GROMACS tools
    • Bugs fixed
    • Removed features
    • Portability
    • Miscellaneous
    • GROMACS 2016.5 Release Notes
    • GROMACS 2016.4 Release Notes
    • GROMACS 2016.3 Release Notes
    • GROMACS 2016.2 Release Notes
    • GROMACS 2016.1 Release Notes
    • Highlights
    • New and improved features
    • Performance improvements
    • GPU improvements
    • CPU improvements
    • Threading improvements
    • Other improvements
    • Improvements to GROMACS tools
    • Bugs fixed
    • Fixes for bugs introduced during development
    • Removed mdrun features
    • Miscellaneous
    • Release notes for older GROMACS versions
  • Installation guide
    • Installation guide for exotic configurations
  • User guide
    • Known issues affecting users of GROMACS
    • Getting started
      • Flow Chart
    • System preparation
    • Managing long simulations
    • Answers to frequently asked questions (FAQs)
    • Force fields in GROMACS
    • Molecular dynamics parameters (.mdp options)
    • Useful mdrun features
    • Getting good performance from mdrun
    • Common errors when using GROMACS
    • Command-line reference
      • molecular dynamics simulation suite
      • gmx anaeig
      • gmx analyze
      • gmx angle
      • gmx awh
      • gmx bar
      • gmx bundle
      • gmx check
      • gmx chi
      • gmx cluster
      • gmx clustsize
      • gmx confrms
      • gmx convert-tpr
      • gmx convert-trj
      • gmx covar
      • gmx current
      • gmx density
      • gmx densmap
      • gmx densorder
      • gmx dielectric
      • gmx dipoles
      • gmx disre
      • gmx distance
      • gmx dos
      • gmx dssp
      • gmx dump
      • gmx dyecoupl
      • gmx editconf
      • gmx eneconv
      • gmx enemat
      • gmx energy
      • gmx extract-cluster
      • gmx filter
      • gmx freevolume
      • gmx gangle
      • gmx genconf
      • gmx genion
      • gmx genrestr
      • gmx grompp
      • gmx gyrate
      • gmx gyrate-legacy
      • gmx h2order
      • gmx hbond
      • gmx hbond-legacy
      • gmx helix
      • gmx helixorient
      • gmx help
      • gmx hydorder
      • gmx insert-molecules
      • gmx lie
      • gmx make_edi
      • gmx make_ndx
      • gmx mdmat
      • gmx mdrun
      • gmx mindist
      • gmx mk_angndx
      • gmx msd
      • gmx nmeig
      • gmx nmens
      • gmx nmr
      • gmx nmtraj
      • gmx nonbonded-benchmark
      • gmx order
      • gmx pairdist
      • gmx pdb2gmx
      • gmx pme_error
      • gmx polystat
      • gmx potential
      • gmx principal
      • gmx rama
      • gmx rdf
      • gmx report-methods
      • gmx rms
      • gmx rmsdist
      • gmx rmsf
      • gmx rotacf
      • gmx rotmat
      • gmx saltbr
      • gmx sans-legacy
      • gmx sasa
      • gmx saxs-legacy
      • gmx scattering
      • gmx select
      • gmx sham
      • gmx sigeps
      • gmx solvate
      • gmx sorient
      • gmx spatial
      • gmx spol
      • gmx tcaf
      • gmx traj
      • gmx trajectory
      • gmx trjcat
      • gmx trjconv
      • gmx trjorder
      • gmx tune_pme
      • gmx vanhove
      • gmx velacc
      • gmx wham
      • gmx wheel
      • gmx x2top
      • gmx xpm2ps
      • Selection syntax and usage
    • Terminology
    • Environment Variables
    • Floating point arithmetic
    • Security when using GROMACS
    • Policy for deprecating GROMACS functionality
  • Short How-To guides
    • Beginners
    • Adding a Residue to a Force Field
    • Water solvation
    • Non water solvent
    • Mixed solvent
    • Making Disulfide Bonds
    • Running membrane simulations in GROMACS
    • Parameterization of novel molecules
    • Potential of Mean Force
    • Single-Point Energy
    • Carbon Nanotube
    • Visualization Software
    • Extracting Trajectory Information
    • External tools to perform trajectory analysis
    • Plotting Data
    • Micelle Clustering
  • Reference Manual
    • Preface and Disclaimer
    • Introduction
    • Definitions and Units
    • Algorithms
      • Periodic boundary conditions
      • The group concept
      • Molecular Dynamics
      • Shell molecular dynamics
      • Constraint algorithms
      • Simulated Annealing
      • Stochastic Dynamics
      • Brownian Dynamics
      • Energy Minimization
      • Normal-Mode Analysis
      • Free energy calculations
      • Replica exchange
      • Essential Dynamics sampling
      • Expanded Ensemble
      • Parallelization
      • Domain decomposition
    • Interaction function and force fields
      • Non-bonded interactions
      • Bonded interactions
      • Restraints
      • Polarization
      • Free energy interactions
      • Methods
      • Virtual interaction sites
      • Long Range Electrostatics
      • Long Range Van der Waals interactions
      • Force field
    • Topologies
      • Particle type
      • Parameter files
      • Molecule definition
      • Constraint algorithms
      • pdb2gmx input files
      • File formats
      • Force field organization
    • File formats
    • Special Topics
      • Free energy implementation
      • Potential of mean force
      • Non-equilibrium pulling
      • Collective variables: the pull code
      • Adaptive biasing with AWH
      • Enforced Rotation
      • Electric fields
      • Computational Electrophysiology
      • Calculating a PMF using the free-energy code
      • Removing fastest degrees of freedom
      • Viscosity calculation
      • Shear simulations
      • Tabulated interaction functions
      • Hybrid Quantum-Classical simulations (QM/MM) with CP2K interface
      • MiMiC Hybrid Quantum Mechanical/Molecular Mechanical simulations
      • Using VMD plug-ins for trajectory file I/O
      • Interactive Molecular Dynamics
      • Embedding proteins into the membranes
      • Applying forces from three-dimensional densities
      • Collective Variable simulations with the Colvars module
    • Run parameters and Programs
    • Analysis
      • Using Groups
      • Looking at your trajectory
      • General properties
      • Radial distribution functions
      • Correlation functions
      • Curve fitting in GROMACS
      • Mean Square Displacement
      • Bonds/distances, angles and dihedrals
      • Radius of gyration and distances
      • Root mean square deviations in structure
      • Covariance analysis
      • Dihedral principal component analysis
      • Hydrogen bonds
      • Protein-related items
      • Interface-related items
    • Some implementation details
    • Averages and fluctuations
    • Bibliography
  • gmxapi Python package
    • Full installation instructions
    • Using the Python package
    • gmxapi Python module reference
  • NBLIB API
    • Guide to Writing MD Programs
  • C++ API
    • Public C++ API
  • Developer Guide
    • Contribute to GROMACS
    • Codebase overview
    • Build system overview
    • Change Management
    • Relocatable binaries
    • Documentation generation
    • Style guidelines
      • Guidelines for code formatting
      • Guidelines for #include directives
      • Naming conventions
      • Allowed language features
      • Guidelines for creating meaningful issue reports
      • Guidelines for formatting of git commits
      • Error handling
    • Development-time tools
      • Using Doxygen
      • Change Management
      • Automation and Infrastructure
        • GitLab CI Pipeline Execution
      • Release engineering with GitLab
      • Source tree checker scripts
      • Automatic source code formatting
      • Unit testing
      • Physical validation
    • Known issues relevant for developers
  • Doxygen documentation
Back to top
Edit this page

NBLIB API#

This documentation is part of the GROMACS manual and describes the nblib API.

Documentation sections

  • Guide to Writing MD Programs
Next
Guide to Writing MD Programs
Previous
gmxapi Python module reference
Copyright © 2024, GROMACS development team
Made with Sphinx and @pradyunsg's Furo