docs/user-guide/tools.rst

   1 Command-line tools
   2 ==================
   3
   4 |Gromacs| includes many tools for preparing, running and analysing
   5 molecular dynamics simulations. These are all structured as part of the
   6 gmx wrapper binary, and invoked with commands like :ref:`gmx grompp`.
   7 :ref:`mdrun <gmx mdrun>` is the only other binary that
   8 :ref:`can be built <building just the mdrun binary>`; in the normal
   9 build it can be run with ``gmx mdrun``. Documentation for these can
  10 be found at the links below:
  11
  12 .. toctree::
  13
  14    /programs/byname
  15    /programs/bytopic
  16
  17 .. toctree::
  18    :hidden:
  19    :glob:
  20
  21    /programs/gmx-*
  22
  23 Common options and behaviour
  24 ----------------------------
  25
  26 Optional files are not used unless the option is set, in contrast to
  27 non-optional files, where the default file name is used when the option is
  28 not set.
  29
  30 All |Gromacs| tools will accept file options without a file extension or
  31 filename being specified. In such cases the default filenames will be
  32 used. With multiple input file types, such as generic structure format,
  33 the directory will be searched for files of each type with the supplied
  34 or default name. When no such file is found, or with output files the
  35 first file type will be used.
  36
  37 All |Gromacs| tools check if the command line options are valid. If this
  38 is not the case, the program will be halted.
  39
  40 All |Gromacs| tools have 3 hidden options:
  41
  42 +-------------------+--------+---------------+-------------------------------------------------+
  43 | option            | type   | default       | description                                     |
  44 +===================+========+===============+=================================================+
  45 | ``-[no]hidden``   | bool   | \[``yes``\]   | \[hidden\] Print description for hidden options |
  46 +-------------------+--------+---------------+-------------------------------------------------+
  47 | ``-[no]quiet``    | bool   | \[``no``\]    | \[hidden\] Do not print help info               |
  48 +-------------------+--------+---------------+-------------------------------------------------+
  49 | ``-[no]debug``    | bool   | \[``no``\]    | \[hidden\] Write file with debug information    |
  50 +-------------------+--------+---------------+-------------------------------------------------+
  51
  52 Many tools accept enumerated options (enum), which should be used with
  53 one of the arguments listed in the option description. The argument may
  54 be abbreviated, and the first match to the shortest argument in the list
  55 will be selected.
  56
  57 Many tools also use options that may accept a vector of values. Either 1
  58 or 3 parameters can be supplied; when only one parameter is supplied the
  59 two other values are also set to this value.
  60
  61 All |Gromacs| tools can read compressed (``*.Z``) or g-zipped (``*.gz``)
  62 files. There might be a problem with reading compressed [.tng] or [.xtc]
  63 files, but these will not compress very well anyway.
  64
  65 Most |Gromacs| tools can process a trajectory with fewer atoms than the
  66 run input or structure file, but only if the trajectory consists of the
  67 first n atoms of the run input or structure file.