docs/user-guide/environment-variables.rst

   1 Environment Variables
   2 =====================
   3
   4 |Gromacs| programs may be influenced by the use of
   5 environment variables.  First of all, the variables set in
   6 the ``GMXRC`` file are essential for running and
   7 compiling |Gromacs|. Some other useful environment variables are
   8 listed in the following sections. Most environment variables function
   9 by being set in your shell to any non-NULL value. Specific
  10 requirements are described below if other values need to be set. You
  11 should consult the documentation for your shell for instructions on
  12 how to set environment variables in the current shell, or in config
  13 files for future shells. Note that requirements for exporting
  14 environment variables to jobs run under batch control systems vary and
  15 you should consult your local documentation for details.
  16
  17 Output Control
  18 --------------
  19 ``GMX_CONSTRAINTVIR``
  20         Print constraint virial and force virial energy terms.
  21
  22 ``GMX_MAXBACKUP``
  23         |Gromacs| automatically backs up old
  24         copies of files when trying to write a new file of the same
  25         name, and this variable controls the maximum number of
  26         backups that will be made, default 99. If set to 0 it fails to
  27         run if any output file already exists. And if set to -1 it
  28         overwrites any output file without making a backup.
  29
  30 ``GMX_NO_QUOTES``
  31         if this is explicitly set, no cool quotes
  32         will be printed at the end of a program.
  33
  34 ``GMX_SUPPRESS_DUMP``
  35         prevent dumping of step files during
  36         (for example) blowing up during failure of constraint
  37         algorithms.
  38
  39 ``GMX_TPI_DUMP``
  40         dump all configurations to a :ref:`pdb`
  41         file that have an interaction energy less than the value set
  42         in this environment variable.
  43
  44 ``GMX_VIEW_XPM``
  45         ``GMX_VIEW_XVG``, ``GMX_VIEW_EPS`` and ``GMX_VIEW_PDB``, commands used to
  46         automatically view :ref:`xvg`, :ref:`xpm`, :ref:`eps`
  47         and :ref:`pdb` file types, respectively; they default to ``xv``, ``xmgrace``,
  48         ``ghostview`` and ``rasmol``. Set to empty to disable
  49         automatic viewing of a particular file type. The command will
  50         be forked off and run in the background at the same priority
  51         as the |Gromacs| tool (which might not be what you want).
  52         Be careful not to use a command which blocks the terminal
  53         (e.g. ``vi``), since multiple instances might be run.
  54
  55 ``GMX_VIRIAL_TEMPERATURE``
  56         print virial temperature energy term
  57
  58 ``GMX_LOG_BUFFER``
  59         the size of the buffer for file I/O. When set
  60         to 0, all file I/O will be unbuffered and therefore very slow.
  61         This can be handy for debugging purposes, because it ensures
  62         that all files are always totally up-to-date.
  63
  64 ``GMX_LOGO_COLOR``
  65         set display color for logo in :ref:`gmx view`.
  66
  67 ``GMX_PRINT_LONGFORMAT``
  68         use long float format when printing
  69         decimal values.
  70
  71 ``GMX_COMPELDUMP``
  72         Applies for computational electrophysiology setups
  73         only (see reference manual). The initial structure gets dumped to
  74         :ref:`pdb` file, which allows to check whether multimeric channels have
  75         the correct PBC representation.
  76
  77 Debugging
  78 ---------
  79 ``GMX_PRINT_DEBUG_LINES``
  80         when set, print debugging info on line numbers.
  81
  82 ``GMX_DD_NST_DUMP``
  83         number of steps that elapse between dumping
  84         the current DD to a PDB file (default 0). This only takes effect
  85         during domain decomposition, so it should typically be
  86         0 (never), 1 (every DD phase) or a multiple of :mdp:`nstlist`.
  87
  88 ``GMX_DD_NST_DUMP_GRID``
  89         number of steps that elapse between dumping
  90         the current DD grid to a PDB file (default 0). This only takes effect
  91         during domain decomposition, so it should typically be
  92         0 (never), 1 (every DD phase) or a multiple of :mdp:`nstlist`.
  93
  94 ``GMX_DD_DEBUG``
  95         general debugging trigger for every domain
  96         decomposition (default 0, meaning off). Currently only checks
  97         global-local atom index mapping for consistency.
  98
  99 ``GMX_DD_NPULSE``
 100         over-ride the number of DD pulses used
 101         (default 0, meaning no over-ride). Normally 1 or 2.
 102
 103 There are a number of extra environment variables like these
 104 that are used in debugging - check the code!
 105
 106 Performance and Run Control
 107 ---------------------------
 108 ``GMX_DO_GALACTIC_DYNAMICS``
 109         planetary simulations are made possible (just for fun) by setting
 110         this environment variable, which allows setting :mdp:`epsilon-r` to -1 in the :ref:`mdp`
 111         file. Normally, :mdp:`epsilon-r` must be greater than zero to prevent a fatal error.
 112         See webpage_ for example input files for a planetary simulation.
 113
 114 ``GMX_ALLOW_CPT_MISMATCH``
 115         when set, runs will not exit if the
 116         ensemble set in the :ref:`tpr` file does not match that of the
 117         :ref:`cpt` file.
 118
 119 ``GMX_CUDA_NB_EWALD_TWINCUT``
 120         force the use of twin-range cutoff kernel even if :mdp:`rvdw` equals
 121         :mdp:`rcoulomb` after PP-PME load balancing. The switch to twin-range kernels is automated,
 122         so this variable should be used only for benchmarking.
 123
 124 ``GMX_CUDA_NB_ANA_EWALD``
 125         force the use of analytical Ewald kernels. Should be used only for benchmarking.
 126
 127 ``GMX_CUDA_NB_TAB_EWALD``
 128         force the use of tabulated Ewald kernels. Should be used only for benchmarking.
 129
 130 ``GMX_CUDA_STREAMSYNC``
 131         force the use of cudaStreamSynchronize on ECC-enabled GPUs, which leads
 132         to performance loss due to a known CUDA driver bug present in API v5.0 NVIDIA drivers (pre-30x.xx).
 133         Cannot be set simultaneously with ``GMX_NO_CUDA_STREAMSYNC``.
 134
 135 ``GMX_CYCLE_ALL``
 136         times all code during runs.  Incompatible with threads.
 137
 138 ``GMX_CYCLE_BARRIER``
 139         calls MPI_Barrier before each cycle start/stop call.
 140
 141 ``GMX_DD_ORDER_ZYX``
 142         build domain decomposition cells in the order
 143         (z, y, x) rather than the default (x, y, z).
 144
 145 ``GMX_DD_USE_SENDRECV2``
 146         during constraint and vsite communication, use a pair
 147         of ``MPI_Sendrecv`` calls instead of two simultaneous non-blocking calls
 148         (default 0, meaning off). Might be faster on some MPI implementations.
 149
 150 ``GMX_DLB_BASED_ON_FLOPS``
 151         do domain-decomposition dynamic load balancing based on flop count rather than
 152         measured time elapsed (default 0, meaning off).
 153         This makes the load balancing reproducible, which can be useful for debugging purposes.
 154         A value of 1 uses the flops; a value > 1 adds (value - 1)*5% of noise to the flops to increase the imbalance and the scaling.
 155
 156 ``GMX_DLB_MAX_BOX_SCALING``
 157         maximum percentage box scaling permitted per domain-decomposition
 158         load-balancing step (default 10)
 159
 160 ``GMX_DD_RECORD_LOAD``
 161         record DD load statistics for reporting at end of the run (default 1, meaning on)
 162
 163 ``GMX_DD_NST_SORT_CHARGE_GROUPS``
 164         number of steps that elapse between re-sorting of the charge
 165         groups (default 1). This only takes effect during domain decomposition, so should typically
 166         be 0 (never), 1 (to mean at every domain decomposition), or a multiple of :mdp:`nstlist`.
 167
 168 ``GMX_DETAILED_PERF_STATS``
 169         when set, print slightly more detailed performance information
 170         to the :ref:`log` file. The resulting output is the way performance summary is reported in versions
 171         4.5.x and thus may be useful for anyone using scripts to parse :ref:`log` files or standard output.
 172
 173 ``GMX_DISABLE_SIMD_KERNELS``
 174         disables architecture-specific SIMD-optimized (SSE2, SSE4.1, AVX, etc.)
 175         non-bonded kernels thus forcing the use of plain C kernels.
 176
 177 ``GMX_DISABLE_CUDA_TIMING``
 178         timing of asynchronously executed GPU operations can have a
 179         non-negligible overhead with short step times. Disabling timing can improve performance in these cases.
 180
 181 ``GMX_DISABLE_GPU_DETECTION``
 182         when set, disables GPU detection even if :ref:`gmx mdrun` was compiled
 183         with GPU support.
 184
 185 ``GMX_DISRE_ENSEMBLE_SIZE``
 186         the number of systems for distance restraint ensemble
 187         averaging. Takes an integer value.
 188
 189 ``GMX_EMULATE_GPU``
 190         emulate GPU runs by using algorithmically equivalent CPU reference code instead of
 191         GPU-accelerated functions. As the CPU code is slow, it is intended to be used only for debugging purposes.
 192         The behavior is automatically triggered if non-bonded calculations are turned off using ``GMX_NO_NONBONDED``
 193         case in which the non-bonded calculations will not be called, but the CPU-GPU transfer will also be skipped.
 194
 195 ``GMX_ENX_NO_FATAL``
 196         disable exiting upon encountering a corrupted frame in an :ref:`edr`
 197         file, allowing the use of all frames up until the corruption.
 198
 199 ``GMX_FORCE_UPDATE``
 200         update forces when invoking ``mdrun -rerun``.
 201
 202 ``GMX_GPU_ID``
 203         set in the same way as ``mdrun -gpu_id``, ``GMX_GPU_ID``
 204         allows the user to specify different GPU id-s, which can be useful for selecting different
 205         devices on different compute nodes in a cluster.  Cannot be used in conjunction with ``mdrun -gpu_id``.
 206
 207 ``GMX_IGNORE_FSYNC_FAILURE_ENV``
 208         allow :ref:`gmx mdrun` to continue even if
 209         a file is missing.
 210
 211 ``GMX_LJCOMB_TOL``
 212         when set to a floating-point value, overrides the default tolerance of
 213         1e-5 for force-field floating-point parameters.
 214
 215 ``GMX_MAX_MPI_THREADS``
 216         sets the maximum number of MPI-threads that :ref:`gmx mdrun`
 217         can use.
 218
 219 ``GMX_MAXCONSTRWARN``
 220         if set to -1, :ref:`gmx mdrun` will
 221         not exit if it produces too many LINCS warnings.
 222
 223 ``GMX_NB_GENERIC``
 224         use the generic C kernel.  Should be set if using
 225         the group-based cutoff scheme and also sets ``GMX_NO_SOLV_OPT`` to be true,
 226         thus disabling solvent optimizations as well.
 227
 228 ``GMX_NB_MIN_CI``
 229         neighbor list balancing parameter used when running on GPU. Sets the
 230         target minimum number pair-lists in order to improve multi-processor load-balance for better
 231         performance with small simulation systems. Must be set to a positive integer, the default value
 232         is optimized for NVIDIA Fermi and Kepler GPUs, therefore changing it is not necessary for
 233         normal usage, but it can be useful on future architectures.
 234
 235 ``GMX_NBLISTCG``
 236         use neighbor list and kernels based on charge groups.
 237
 238 ``GMX_NBNXN_CYCLE``
 239         when set, print detailed neighbor search cycle counting.
 240
 241 ``GMX_NBNXN_EWALD_ANALYTICAL``
 242         force the use of analytical Ewald non-bonded kernels,
 243         mutually exclusive of ``GMX_NBNXN_EWALD_TABLE``.
 244
 245 ``GMX_NBNXN_EWALD_TABLE``
 246         force the use of tabulated Ewald non-bonded kernels,
 247         mutually exclusive of ``GMX_NBNXN_EWALD_ANALYTICAL``.
 248
 249 ``GMX_NBNXN_SIMD_2XNN``
 250         force the use of 2x(N+N) SIMD CPU non-bonded kernels,
 251         mutually exclusive of ``GMX_NBNXN_SIMD_4XN``.
 252
 253 ``GMX_NBNXN_SIMD_4XN``
 254         force the use of 4xN SIMD CPU non-bonded kernels,
 255         mutually exclusive of ``GMX_NBNXN_SIMD_2XNN``.
 256
 257 ``GMX_NO_ALLVSALL``
 258         disables optimized all-vs-all kernels.
 259
 260 ``GMX_NO_CART_REORDER``
 261         used in initializing domain decomposition communicators. Rank reordering
 262         is default, but can be switched off with this environment variable.
 263
 264 ``GMX_NO_CUDA_STREAMSYNC``
 265         the opposite of ``GMX_CUDA_STREAMSYNC``. Disables the use of the
 266         standard cudaStreamSynchronize-based GPU waiting to improve performance when using CUDA driver API
 267         ealier than v5.0 with ECC-enabled GPUs.
 268
 269 ``GMX_NO_INT``, ``GMX_NO_TERM``, ``GMX_NO_USR1``
 270         disable signal handlers for SIGINT,
 271         SIGTERM, and SIGUSR1, respectively.
 272
 273 ``GMX_NO_NODECOMM``
 274         do not use separate inter- and intra-node communicators.
 275
 276 ``GMX_NO_NONBONDED``
 277         skip non-bonded calculations; can be used to estimate the possible
 278         performance gain from adding a GPU accelerator to the current hardware setup -- assuming that this is
 279         fast enough to complete the non-bonded calculations while the CPU does bonded force and PME computation.
 280
 281 ``GMX_NO_PULLVIR``
 282         when set, do not add virial contribution to COM pull forces.
 283
 284 ``GMX_NOCHARGEGROUPS``
 285         disables multi-atom charge groups, i.e. each atom
 286         in all non-solvent molecules is assigned its own charge group.
 287
 288 ``GMX_NOPREDICT``
 289         shell positions are not predicted.
 290
 291 ``GMX_NO_SOLV_OPT``
 292         turns off solvent optimizations; automatic if ``GMX_NB_GENERIC``
 293         is enabled.
 294
 295 ``GMX_NSCELL_NCG``
 296         the ideal number of charge groups per neighbor searching grid cell is hard-coded
 297         to a value of 10. Setting this environment variable to any other integer value overrides this hard-coded
 298         value.
 299
 300 ``GMX_PME_NTHREADS``
 301         set the number of OpenMP or PME threads (overrides the number guessed by
 302         :ref:`gmx mdrun`.
 303
 304 ``GMX_PME_P3M``
 305         use P3M-optimized influence function instead of smooth PME B-spline interpolation.
 306
 307 ``GMX_PME_THREAD_DIVISION``
 308         PME thread division in the format "x y z" for all three dimensions. The
 309         sum of the threads in each dimension must equal the total number of PME threads (set in
 310         `GMX_PME_NTHREADS`).
 311
 312 ``GMX_PMEONEDD``
 313         if the number of domain decomposition cells is set to 1 for both x and y,
 314         decompose PME in one dimension.
 315
 316 ``GMX_REQUIRE_SHELL_INIT``
 317         require that shell positions are initiated.
 318
 319 ``GMX_REQUIRE_TABLES``
 320         require the use of tabulated Coulombic
 321         and van der Waals interactions.
 322
 323 ``GMX_SCSIGMA_MIN``
 324         the minimum value for soft-core sigma. **Note** that this value is set
 325         using the :mdp:`sc-sigma` keyword in the :ref:`mdp` file, but this environment variable can be used
 326         to reproduce pre-4.5 behavior with respect to this parameter.
 327
 328 ``GMX_TPIC_MASSES``
 329         should contain multiple masses used for test particle insertion into a cavity.
 330         The center of mass of the last atoms is used for insertion into the cavity.
 331
 332 ``GMX_USE_GRAPH``
 333         use graph for bonded interactions.
 334
 335 ``GMX_VERLET_BUFFER_RES``
 336         resolution of buffer size in Verlet cutoff scheme.  The default value is
 337         0.001, but can be overridden with this environment variable.
 338
 339 ``MPIRUN``
 340         the ``mpirun`` command used by :ref:`gmx tune_pme`.
 341
 342 ``MDRUN``
 343         the :ref:`gmx mdrun` command used by :ref:`gmx tune_pme`.
 344
 345 ``GMX_NSTLIST``
 346         sets the default value for :mdp:`nstlist`, preventing it from being tuned during
 347         :ref:`gmx mdrun` startup when using the Verlet cutoff scheme.
 348
 349 ``GMX_USE_TREEREDUCE``
 350         use tree reduction for nbnxn force reduction. Potentially faster for large number of
 351         OpenMP threads (if memory locality is important).
 352
 353 Analysis and Core Functions
 354 ---------------------------
 355 ``GMX_QM_ACCURACY``
 356         accuracy in Gaussian L510 (MC-SCF) component program.
 357
 358 ``GMX_QM_ORCA_BASENAME``
 359         prefix of :ref:`tpr` files, used in Orca calculations
 360         for input and output file names.
 361
 362 ``GMX_QM_CPMCSCF``
 363         when set to a nonzero value, Gaussian QM calculations will
 364         iteratively solve the CP-MCSCF equations.
 365
 366 ``GMX_QM_MODIFIED_LINKS_DIR``
 367         location of modified links in Gaussian.
 368
 369 ``DSSP``
 370         used by :ref:`gmx do_dssp` to point to the ``dssp``
 371         executable (not just its path).
 372
 373 ``GMX_QM_GAUSS_DIR``
 374         directory where Gaussian is installed.
 375
 376 ``GMX_QM_GAUSS_EXE``
 377         name of the Gaussian executable.
 378
 379 ``GMX_DIPOLE_SPACING``
 380         spacing used by :ref:`gmx dipoles`.
 381
 382 ``GMX_MAXRESRENUM``
 383         sets the maximum number of residues to be renumbered by
 384         :ref:`gmx grompp`. A value of -1 indicates all residues should be renumbered.
 385
 386 ``GMX_FFRTP_TER_RENAME``
 387         Some force fields (like AMBER) use specific names for N- and C-
 388         terminal residues (NXXX and CXXX) as :ref:`rtp` entries that are normally renamed. Setting
 389         this environment variable disables this renaming.
 390
 391 ``GMX_PATH_GZIP``
 392         ``gunzip`` executable, used by :ref:`gmx wham`.
 393
 394 ``GMX_FONT``
 395         name of X11 font used by :ref:`gmx view`.
 396
 397 ``GMXTIMEUNIT``
 398         the time unit used in output files, can be
 399         anything in fs, ps, ns, us, ms, s, m or h.
 400
 401 ``GMX_QM_GAUSSIAN_MEMORY``
 402         memory used for Gaussian QM calculation.
 403
 404 ``MULTIPROT``
 405         name of the ``multiprot`` executable, used by the
 406         contributed program ``do_multiprot``.
 407
 408 ``NCPUS``
 409         number of CPUs to be used for Gaussian QM calculation
 410
 411 ``GMX_ORCA_PATH``
 412         directory where Orca is installed.
 413
 414 ``GMX_QM_SA_STEP``
 415         simulated annealing step size for Gaussian QM calculation.
 416
 417 ``GMX_QM_GROUND_STATE``
 418         defines state for Gaussian surface hopping calculation.
 419
 420 ``GMX_TOTAL``
 421         name of the ``total`` executable used by the contributed
 422         ``do_shift`` program.
 423
 424 ``GMX_ENER_VERBOSE``
 425         make :ref:`gmx energy` and :ref:`gmx eneconv`
 426         loud and noisy.
 427
 428 ``VMD_PLUGIN_PATH``
 429         where to find VMD plug-ins. Needed to be
 430         able to read file formats recognized only by a VMD plug-in.
 431
 432 ``VMDDIR``
 433         base path of VMD installation.
 434
 435 ``GMX_USE_XMGR``
 436         sets viewer to ``xmgr`` (deprecated) instead of ``xmgrace``.