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 configuration
  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 ``GMX_TRAJECTORY_IO_VERBOSITY``
  78         Defaults to 1, which prints frame count e.g. when reading trajectory
  79         files. Set to 0 for quiet operation.
  80
  81 Debugging
  82 ---------
  83 ``GMX_PRINT_DEBUG_LINES``
  84         when set, print debugging info on line numbers.
  85
  86 ``GMX_DD_NST_DUMP``
  87         number of steps that elapse between dumping
  88         the current DD to a PDB file (default 0). This only takes effect
  89         during domain decomposition, so it should typically be
  90         0 (never), 1 (every DD phase) or a multiple of :mdp:`nstlist`.
  91
  92 ``GMX_DD_NST_DUMP_GRID``
  93         number of steps that elapse between dumping
  94         the current DD grid to a PDB file (default 0). This only takes effect
  95         during domain decomposition, so it should typically be
  96         0 (never), 1 (every DD phase) or a multiple of :mdp:`nstlist`.
  97
  98 ``GMX_DD_DEBUG``
  99         general debugging trigger for every domain
 100         decomposition (default 0, meaning off). Currently only checks
 101         global-local atom index mapping for consistency.
 102
 103 ``GMX_DD_NPULSE``
 104         over-ride the number of DD pulses used
 105         (default 0, meaning no over-ride). Normally 1 or 2.
 106
 107 There are a number of extra environment variables like these
 108 that are used in debugging - check the code!
 109
 110 Performance and Run Control
 111 ---------------------------
 112 ``GMX_DO_GALACTIC_DYNAMICS``
 113         planetary simulations are made possible (just for fun) by setting
 114         this environment variable, which allows setting :mdp:`epsilon-r` to -1 in the :ref:`mdp`
 115         file. Normally, :mdp:`epsilon-r` must be greater than zero to prevent a fatal error.
 116         See webpage_ for example input files for a planetary simulation.
 117
 118 ``GMX_ALLOW_CPT_MISMATCH``
 119         when set, runs will not exit if the
 120         ensemble set in the :ref:`tpr` file does not match that of the
 121         :ref:`cpt` file.
 122
 123 ``GMX_CUDA_NB_EWALD_TWINCUT``
 124         force the use of twin-range cutoff kernel even if :mdp:`rvdw` equals
 125         :mdp:`rcoulomb` after PP-PME load balancing. The switch to twin-range kernels is automated,
 126         so this variable should be used only for benchmarking.
 127
 128 ``GMX_CUDA_NB_ANA_EWALD``
 129         force the use of analytical Ewald kernels. Should be used only for benchmarking.
 130
 131 ``GMX_CUDA_NB_TAB_EWALD``
 132         force the use of tabulated Ewald kernels. Should be used only for benchmarking.
 133
 134 ``GMX_CUDA_STREAMSYNC``
 135         force the use of cudaStreamSynchronize on ECC-enabled GPUs, which leads
 136         to performance loss due to a known CUDA driver bug present in API v5.0 NVIDIA drivers (pre-30x.xx).
 137         Cannot be set simultaneously with ``GMX_NO_CUDA_STREAMSYNC``.
 138
 139 ``GMX_DISABLE_CUDALAUNCH``
 140         disable the use of the lower-latency cudaLaunchKernel API even when supported (CUDA >=v7.0).
 141         Should only be used for benchmarking purposes.
 142
 143 ``GMX_DISABLE_CUDA_TIMING``
 144         Disables GPU timing of CUDA tasks; synonymous with ``GMX_DISABLE_GPU_TIMING``.
 145
 146 ``GMX_CYCLE_ALL``
 147         times all code during runs.  Incompatible with threads.
 148
 149 ``GMX_CYCLE_BARRIER``
 150         calls MPI_Barrier before each cycle start/stop call.
 151
 152 ``GMX_DD_ORDER_ZYX``
 153         build domain decomposition cells in the order
 154         (z, y, x) rather than the default (x, y, z).
 155
 156 ``GMX_DD_USE_SENDRECV2``
 157         during constraint and vsite communication, use a pair
 158         of ``MPI_Sendrecv`` calls instead of two simultaneous non-blocking calls
 159         (default 0, meaning off). Might be faster on some MPI implementations.
 160
 161 ``GMX_DLB_BASED_ON_FLOPS``
 162         do domain-decomposition dynamic load balancing based on flop count rather than
 163         measured time elapsed (default 0, meaning off).
 164         This makes the load balancing reproducible, which can be useful for debugging purposes.
 165         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.
 166
 167 ``GMX_DLB_MAX_BOX_SCALING``
 168         maximum percentage box scaling permitted per domain-decomposition
 169         load-balancing step (default 10)
 170
 171 ``GMX_DD_RECORD_LOAD``
 172         record DD load statistics for reporting at end of the run (default 1, meaning on)
 173
 174 ``GMX_DETAILED_PERF_STATS``
 175         when set, print slightly more detailed performance information
 176         to the :ref:`log` file. The resulting output is the way performance summary is reported in versions
 177         4.5.x and thus may be useful for anyone using scripts to parse :ref:`log` files or standard output.
 178
 179 ``GMX_DISABLE_SIMD_KERNELS``
 180         disables architecture-specific SIMD-optimized (SSE2, SSE4.1, AVX, etc.)
 181         non-bonded kernels thus forcing the use of plain C kernels.
 182
 183 ``GMX_DISABLE_GPU_TIMING``
 184         timing of asynchronously executed GPU operations can have a
 185         non-negligible overhead with short step times. Disabling timing can improve performance in these cases.
 186
 187 ``GMX_DISABLE_GPU_DETECTION``
 188         when set, disables GPU detection even if :ref:`gmx mdrun` was compiled
 189         with GPU support.
 190
 191 ``GMX_GPU_APPLICATION_CLOCKS``
 192         setting this variable to a value of "0", "ON", or "DISABLE" (case insensitive)
 193         allows disabling the CUDA GPU allication clock support.
 194
 195 ``GMX_DISRE_ENSEMBLE_SIZE``
 196         the number of systems for distance restraint ensemble
 197         averaging. Takes an integer value.
 198
 199 ``GMX_EMULATE_GPU``
 200         emulate GPU runs by using algorithmically equivalent CPU reference code instead of
 201         GPU-accelerated functions. As the CPU code is slow, it is intended to be used only for debugging purposes.
 202         The behavior is automatically triggered if non-bonded calculations are turned off using ``GMX_NO_NONBONDED``
 203         case in which the non-bonded calculations will not be called, but the CPU-GPU transfer will also be skipped.
 204
 205 ``GMX_ENX_NO_FATAL``
 206         disable exiting upon encountering a corrupted frame in an :ref:`edr`
 207         file, allowing the use of all frames up until the corruption.
 208
 209 ``GMX_FORCE_UPDATE``
 210         update forces when invoking ``mdrun -rerun``.
 211
 212 ``GMX_GPU_ID``
 213         set in the same way as ``mdrun -gpu_id``, ``GMX_GPU_ID``
 214         allows the user to specify different GPU id-s, which can be useful for selecting different
 215         devices on different compute nodes in a cluster.  Cannot be used in conjunction with ``mdrun -gpu_id``.
 216
 217 ``GMX_IGNORE_FSYNC_FAILURE_ENV``
 218         allow :ref:`gmx mdrun` to continue even if
 219         a file is missing.
 220
 221 ``GMX_LJCOMB_TOL``
 222         when set to a floating-point value, overrides the default tolerance of
 223         1e-5 for force-field floating-point parameters.
 224
 225 ``GMX_MAXCONSTRWARN``
 226         if set to -1, :ref:`gmx mdrun` will
 227         not exit if it produces too many LINCS warnings.
 228
 229 ``GMX_NB_GENERIC``
 230         use the generic C kernel.  Should be set if using
 231         the group-based cutoff scheme and also sets ``GMX_NO_SOLV_OPT`` to be true,
 232         thus disabling solvent optimizations as well.
 233
 234 ``GMX_NB_MIN_CI``
 235         neighbor list balancing parameter used when running on GPU. Sets the
 236         target minimum number pair-lists in order to improve multi-processor load-balance for better
 237         performance with small simulation systems. Must be set to a non-negative integer,
 238         the 0 value disables list splitting.
 239         The default value is optimized for supported GPUs (NVIDIA Fermi to Maxwell),
 240         therefore changing it is not necessary for normal usage, but it can be useful on future architectures.
 241
 242 ``GMX_NBLISTCG``
 243         use neighbor list and kernels based on charge groups.
 244
 245 ``GMX_NBNXN_CYCLE``
 246         when set, print detailed neighbor search cycle counting.
 247
 248 ``GMX_NBNXN_EWALD_ANALYTICAL``
 249         force the use of analytical Ewald non-bonded kernels,
 250         mutually exclusive of ``GMX_NBNXN_EWALD_TABLE``.
 251
 252 ``GMX_NBNXN_EWALD_TABLE``
 253         force the use of tabulated Ewald non-bonded kernels,
 254         mutually exclusive of ``GMX_NBNXN_EWALD_ANALYTICAL``.
 255
 256 ``GMX_NBNXN_SIMD_2XNN``
 257         force the use of 2x(N+N) SIMD CPU non-bonded kernels,
 258         mutually exclusive of ``GMX_NBNXN_SIMD_4XN``.
 259
 260 ``GMX_NBNXN_SIMD_4XN``
 261         force the use of 4xN SIMD CPU non-bonded kernels,
 262         mutually exclusive of ``GMX_NBNXN_SIMD_2XNN``.
 263
 264 ``GMX_NO_ALLVSALL``
 265         disables optimized all-vs-all kernels.
 266
 267 ``GMX_NO_CART_REORDER``
 268         used in initializing domain decomposition communicators. Rank reordering
 269         is default, but can be switched off with this environment variable.
 270
 271 ``GMX_NO_LJ_COMB_RULE``
 272         force the use of LJ paremeter lookup instead of using combination rules
 273         in the non-bonded kernels.
 274
 275 ``GMX_NO_CUDA_STREAMSYNC``
 276         the opposite of ``GMX_CUDA_STREAMSYNC``. Disables the use of the
 277         standard cudaStreamSynchronize-based GPU waiting to improve performance when using CUDA driver API
 278         ealier than v5.0 with ECC-enabled GPUs.
 279
 280 ``GMX_NO_INT``, ``GMX_NO_TERM``, ``GMX_NO_USR1``
 281         disable signal handlers for SIGINT,
 282         SIGTERM, and SIGUSR1, respectively.
 283
 284 ``GMX_NO_NODECOMM``
 285         do not use separate inter- and intra-node communicators.
 286
 287 ``GMX_NO_NONBONDED``
 288         skip non-bonded calculations; can be used to estimate the possible
 289         performance gain from adding a GPU accelerator to the current hardware setup -- assuming that this is
 290         fast enough to complete the non-bonded calculations while the CPU does bonded force and PME computation.
 291
 292 ``GMX_NO_PULLVIR``
 293         when set, do not add virial contribution to COM pull forces.
 294
 295 ``GMX_NOPREDICT``
 296         shell positions are not predicted.
 297
 298 ``GMX_NO_SOLV_OPT``
 299         turns off solvent optimizations; automatic if ``GMX_NB_GENERIC``
 300         is enabled.
 301
 302 ``GMX_NSCELL_NCG``
 303         the ideal number of charge groups per neighbor searching grid cell is hard-coded
 304         to a value of 10. Setting this environment variable to any other integer value overrides this hard-coded
 305         value.
 306
 307 ``GMX_PME_NTHREADS``
 308         set the number of OpenMP or PME threads (overrides the number guessed by
 309         :ref:`gmx mdrun`.
 310
 311 ``GMX_PME_P3M``
 312         use P3M-optimized influence function instead of smooth PME B-spline interpolation.
 313
 314 ``GMX_PME_THREAD_DIVISION``
 315         PME thread division in the format "x y z" for all three dimensions. The
 316         sum of the threads in each dimension must equal the total number of PME threads (set in
 317         `GMX_PME_NTHREADS`).
 318
 319 ``GMX_PMEONEDD``
 320         if the number of domain decomposition cells is set to 1 for both x and y,
 321         decompose PME in one dimension.
 322
 323 ``GMX_REQUIRE_SHELL_INIT``
 324         require that shell positions are initiated.
 325
 326 ``GMX_REQUIRE_TABLES``
 327         require the use of tabulated Coulombic
 328         and van der Waals interactions.
 329
 330 ``GMX_SCSIGMA_MIN``
 331         the minimum value for soft-core sigma. **Note** that this value is set
 332         using the :mdp:`sc-sigma` keyword in the :ref:`mdp` file, but this environment variable can be used
 333         to reproduce pre-4.5 behavior with respect to this parameter.
 334
 335 ``GMX_TPIC_MASSES``
 336         should contain multiple masses used for test particle insertion into a cavity.
 337         The center of mass of the last atoms is used for insertion into the cavity.
 338
 339 ``GMX_USE_GRAPH``
 340         use graph for bonded interactions.
 341
 342 ``GMX_VERLET_BUFFER_RES``
 343         resolution of buffer size in Verlet cutoff scheme.  The default value is
 344         0.001, but can be overridden with this environment variable.
 345
 346 ``HWLOC_XMLFILE``
 347         Not strictly a |Gromacs| environment variable, but on large machines
 348         the hwloc detection can take a few seconds if you have lots of MPI processes.
 349         If you run the hwloc command `lstopo out.xml` and set this environment
 350         variable to point to the location of this file, the hwloc library will use
 351         the cached information instead, which can be faster.
 352
 353 ``MPIRUN``
 354         the ``mpirun`` command used by :ref:`gmx tune_pme`.
 355
 356 ``MDRUN``
 357         the :ref:`gmx mdrun` command used by :ref:`gmx tune_pme`.
 358
 359 ``GMX_NSTLIST``
 360         sets the default value for :mdp:`nstlist`, preventing it from being tuned during
 361         :ref:`gmx mdrun` startup when using the Verlet cutoff scheme.
 362
 363 ``GMX_USE_TREEREDUCE``
 364         use tree reduction for nbnxn force reduction. Potentially faster for large number of
 365         OpenMP threads (if memory locality is important).
 366
 367 .. _opencl-management:
 368
 369 OpenCL management
 370 -----------------
 371 Currently, several environment variables exist that help customize some aspects
 372 of the OpenCL_ version of |Gromacs|. They are mostly related to the runtime
 373 compilation of OpenCL kernels, but they are also used in device selection.
 374
 375 ``GMX_OCL_NOGENCACHE``
 376         If set, disable caching for OpenCL kernel builds. Caching is
 377         normally useful so that future runs can re-use the compiled
 378         kernels from previous runs. Currently, caching is always
 379         disabled, until we solve concurrency issues.
 380
 381 ``GMX_OCL_GENCACHE``
 382         Enable OpenCL binary caching. Only intended to be used for
 383         development and (expert) testing as neither concurrency
 384         nor cache invalidation is implemented safely!
 385
 386 ``GMX_OCL_NOFASTGEN``
 387         If set, generate and compile all algorithm flavors, otherwise
 388         only the flavor required for the simulation is generated and
 389         compiled.
 390
 391 ``GMX_OCL_DISABLE_FASTMATH``
 392         Prevents the use of ``-cl-fast-relaxed-math`` compiler option.
 393
 394 ``GMX_OCL_DUMP_LOG``
 395         If defined, the OpenCL build log is always written to the
 396         mdrun log file. Otherwise, the build log is written to the
 397         log file only when an error occurs.
 398
 399 ``GMX_OCL_VERBOSE``
 400         If defined, it enables verbose mode for OpenCL kernel build.
 401         Currently available only for NVIDIA GPUs. See ``GMX_OCL_DUMP_LOG``
 402         for details about how to obtain the OpenCL build log.
 403
 404 ``GMX_OCL_DUMP_INTERM_FILES``
 405
 406         If defined, intermediate language code corresponding to the
 407         OpenCL build process is saved to file. Caching has to be
 408         turned off in order for this option to take effect (see
 409         ``GMX_OCL_NOGENCACHE``).
 410
 411             - NVIDIA GPUs: PTX code is saved in the current directory
 412               with the name ``device_name.ptx``
 413             - AMD GPUs: ``.IL/.ISA`` files will be created for each OpenCL
 414               kernel built.  For details about where these files are
 415               created check AMD documentation for ``-save-temps`` compiler
 416               option.
 417
 418 ``GMX_OCL_DEBUG``
 419         Use in conjunction with ``OCL_FORCE_CPU`` or with an AMD device.
 420         It adds the debug flag to the compiler options (-g).
 421
 422 ``GMX_OCL_NOOPT``
 423         Disable optimisations. Adds the option ``cl-opt-disable`` to the
 424         compiler options.
 425
 426 ``GMX_OCL_FORCE_CPU``
 427         Force the selection of a CPU device instead of a GPU.  This
 428         exists only for debugging purposes. Do not expect |Gromacs| to
 429         function properly with this option on, it is solely for the
 430         simplicity of stepping in a kernel and see what is happening.
 431
 432 ``GMX_OCL_DISABLE_I_PREFETCH``
 433         Disables i-atom data (type or LJ parameter) prefetch allowig
 434         testing.
 435
 436 ``GMX_OCL_ENABLE_I_PREFETCH``
 437         Enables i-atom data (type or LJ parameter) prefetch allowig
 438         testing on platforms where this behavior is not default.
 439
 440 ``GMX_OCL_NB_ANA_EWALD``
 441         Forces the use of analytical Ewald kernels. Equivalent of
 442         CUDA environment variable ``GMX_CUDA_NB_ANA_EWALD``
 443
 444 ``GMX_OCL_NB_TAB_EWALD``
 445         Forces the use of tabulated Ewald kernel. Equivalent
 446         of CUDA environment variable ``GMX_OCL_NB_TAB_EWALD``
 447
 448 ``GMX_OCL_NB_EWALD_TWINCUT``
 449         Forces the use of twin-range cutoff kernel. Equivalent of
 450         CUDA environment variable ``GMX_CUDA_NB_EWALD_TWINCUT``
 451
 452 ``GMX_DISABLE_OCL_TIMING``
 453         Disables timing for OpenCL operations
 454
 455 ``GMX_OCL_FILE_PATH``
 456         Use this parameter to force |Gromacs| to load the OpenCL
 457         kernels from a custom location. Use it only if you want to
 458         override |Gromacs| default behavior, or if you want to test
 459         your own kernels.
 460
 461 Analysis and Core Functions
 462 ---------------------------
 463 ``GMX_QM_ACCURACY``
 464         accuracy in Gaussian L510 (MC-SCF) component program.
 465
 466 ``GMX_QM_ORCA_BASENAME``
 467         prefix of :ref:`tpr` files, used in Orca calculations
 468         for input and output file names.
 469
 470 ``GMX_QM_CPMCSCF``
 471         when set to a nonzero value, Gaussian QM calculations will
 472         iteratively solve the CP-MCSCF equations.
 473
 474 ``GMX_QM_MODIFIED_LINKS_DIR``
 475         location of modified links in Gaussian.
 476
 477 ``DSSP``
 478         used by :ref:`gmx do_dssp` to point to the ``dssp``
 479         executable (not just its path).
 480
 481 ``GMX_QM_GAUSS_DIR``
 482         directory where Gaussian is installed.
 483
 484 ``GMX_QM_GAUSS_EXE``
 485         name of the Gaussian executable.
 486
 487 ``GMX_DIPOLE_SPACING``
 488         spacing used by :ref:`gmx dipoles`.
 489
 490 ``GMX_MAXRESRENUM``
 491         sets the maximum number of residues to be renumbered by
 492         :ref:`gmx grompp`. A value of -1 indicates all residues should be renumbered.
 493
 494 ``GMX_FFRTP_TER_RENAME``
 495         Some force fields (like AMBER) use specific names for N- and C-
 496         terminal residues (NXXX and CXXX) as :ref:`rtp` entries that are normally renamed. Setting
 497         this environment variable disables this renaming.
 498
 499 ``GMX_PATH_GZIP``
 500         ``gunzip`` executable, used by :ref:`gmx wham`.
 501
 502 ``GMX_FONT``
 503         name of X11 font used by :ref:`gmx view`.
 504
 505 ``GMXTIMEUNIT``
 506         the time unit used in output files, can be
 507         anything in fs, ps, ns, us, ms, s, m or h.
 508
 509 ``GMX_QM_GAUSSIAN_MEMORY``
 510         memory used for Gaussian QM calculation.
 511
 512 ``MULTIPROT``
 513         name of the ``multiprot`` executable, used by the
 514         contributed program ``do_multiprot``.
 515
 516 ``NCPUS``
 517         number of CPUs to be used for Gaussian QM calculation
 518
 519 ``GMX_ORCA_PATH``
 520         directory where Orca is installed.
 521
 522 ``GMX_QM_SA_STEP``
 523         simulated annealing step size for Gaussian QM calculation.
 524
 525 ``GMX_QM_GROUND_STATE``
 526         defines state for Gaussian surface hopping calculation.
 527
 528 ``GMX_TOTAL``
 529         name of the ``total`` executable used by the contributed
 530         ``do_shift`` program.
 531
 532 ``GMX_ENER_VERBOSE``
 533         make :ref:`gmx energy` and :ref:`gmx eneconv`
 534         loud and noisy.
 535
 536 ``VMD_PLUGIN_PATH``
 537         where to find VMD plug-ins. Needed to be
 538         able to read file formats recognized only by a VMD plug-in.
 539
 540 ``VMDDIR``
 541         base path of VMD installation.
 542
 543 ``GMX_USE_XMGR``
 544         sets viewer to ``xmgr`` (deprecated) instead of ``xmgrace``.