GROMACS

GROMACS is a versatile package to perform molecular dynamics, i.e. simulate the Newtonian equations of motion for systems with hundreds, to millions of particles. See www.gromacs.org for more information.

This documentation generated by Doxygen is (mostly) extracted from the source code, and provides documentation for understanding the source code. The documentation can be generated with different levels of details. This documentation has been generated to include documentation of functions in the library intended for reuse within the library (a subset of these functions is also exposed as a public API). Also overview documentation aimed at GROMACS developers is included at this level.

The main audience for this level of detail are users and developers who want to understand the GROMACS code in general. If you only want to call GROMACS, but not modify it, the public API documentation provides a cleaner entry point. If you are interested in internal implementation details not described here, you can try searching the full documentation.

Currently, only parts of the code are documented here. The following pages give an overview of some of the topics that are documented:

• Framework for trajectory analysis
  Provides an overview of the framework that the GROMACS library provides for writing (trajectory) analysis tools.
• Help formatting
  Provides an overview of the formatting markup available in help texts.
• Using GROMACS as a library
  Provides general guidance for writing software that uses the GROMACS library.
• Wrapper binary implementation
  Provides an overview of how the gmx wrapper binary is implemented.
• Logging
  Documentation for logging and status output (for now, within mdrun).
• Single-instruction Multiple-data (SIMD) coding
  Documentation about the new SIMD module that makes it possible to write highly accelerated CPU code that is still portable.
• The accelerated weight histogram method (AWH)
  Documentation about the accelerated weight histogram (AWH) method, which is used for accelerating sampling along reaction coordinates.
• mdrun modules
  Documentation for work-in-progress modularization of parts of mdrun, that should make it easier to implement additional features as add-ons on top of a common interface.
• Using reference data in C++ tests
  Documentation for writing tests that use reference data generated by the same test.
• The modular simulator
  Documentation of the modular simulator approach.
• Module dependency graph
  Automatically generated module dependency graph.

This list will hopefully expand over time.