1 Welcome to the |Gromacs| documentation!
2 =======================================
4 .. TODO : consolidate at least some of the material in the
5 Documentation links below into the new user guide, along with all
6 of http://www.gromacs.org/Documentation/Cut-off_schemes,
7 http://www.gromacs.org/Documentation/Acceleration_and_parallelization
8 and http://www.gromacs.org/Documentation/Performance_checklist)
20 * `Reference Manual`_ (PDF format)
22 * Answers to `Frequently Asked Questions <http://www.gromacs.org/Documentation/FAQs>`_
24 * Coping with `errors while using GROMACS <http://www.gromacs.org/Documentation/Errors>`_
26 * Links to `tutorial material <http://www.gromacs.org/Documentation/Tutorials>`_
28 Documentation for developers
29 ----------------------------
31 The developer documentation currently consists of two parts:
33 * A developer guide that provides an overview of the |Gromacs| codebase, and
34 includes more detailed resouces such as guidelines and information on tools
35 used during development.
36 * Doxygen documentation extracted from comments in C/C++ code, documenting the
39 Some overview documentation that is closely related to the actual C/C++ code
40 appears in the Doxygen documentation, while some other overview content is in
41 the developer guide. The reasons are partially technical, but crosslinks
42 between the developer guide and the Doxygen documentation are provided whenever
43 related content appears split between the two sources.
45 The documentation does not yet cover all areas, but more content is being
55 * Doxygen documentation
57 * `Public API documentation <doxygen/html-user/index.xhtml>`_
58 This contains documentation for code that appears in installed headers,
59 as well as some overview documentation to understand those parts of the
61 Please note that the definition of the public API is very preliminary
62 and subject to change, in particular for parts that have not been
64 * `Code documentation <doxygen/html-lib/index.xhtml>`_
65 This contains the public API documentation as a subset, but also has more
66 details on the internal implementation of |Gromacs|. This is a good
67 place to start to understand some specific area of the code in general
69 * `Full documentation <doxygen/html-full/index.xhtml>`_
70 This contains every single documented function from the codebase,
71 including internal There can be an overwhelming amount of detail, but
72 this can be useful if trying to find some specific function within the
81 .. _Reference Manual: `gmx-manual`_