Removed dependency on commrec of mdrun setup
[gromacs.git] / docs / user-guide / environment-variables.rst
blob5d8f77e59dc4cdce31db2f935ec3aa5d19709229
1 .. NOTE: Below is a useful bash one-liner to verify whether there are variables in this file
2 ..        no longer present in the code.
3 .. ( export INPUT_FILE='docs/user-guide/environment-variables.rst' GIT_PAGER="cat "; for s in $(grep '^`'  $INPUT_FILE | sed 's/`//g' | sed 's/,/ /g'); do count=$(git grep $s | grep -v $INPUT_FILE | wc -l); [ $count -eq 0 ] && printf "%-30s%s\n" $s $count; done ; )
4 .. Another useful one-liner to find undocumentedvariables:
5 ..  ( export INPUT_FILE=docs/user-guide/environment-variables.rst; GIT_PAGER="cat ";   for ss in `for s in $(git grep getenv |  sed 's/.*getenv("\(.*\)".*/\1/' | sort -u  | grep '^[A-Z]'); do [ $(grep $s $INPUT_FILE -c) -eq 0 ] && echo $s; done `; do git grep $ss ; done )
7 .. TODO: still undocumented GMX_QM_GAUSSIAN_NCPUS
9 Environment Variables
10 =====================
12 |Gromacs| programs may be influenced by the use of
13 environment variables.  First of all, the variables set in
14 the ``GMXRC`` file are essential for running and
15 compiling |Gromacs|. Some other useful environment variables are
16 listed in the following sections. Most environment variables function
17 by being set in your shell to any non-NULL value. Specific
18 requirements are described below if other values need to be set. You
19 should consult the documentation for your shell for instructions on
20 how to set environment variables in the current shell, or in configuration
21 files for future shells. Note that requirements for exporting
22 environment variables to jobs run under batch control systems vary and
23 you should consult your local documentation for details.
25 Output Control
26 --------------
27 ``GMX_CONSTRAINTVIR``
28         Print constraint virial and force virial energy terms.
30 ``GMX_DUMP_NL``
31         Neighbour list dump level; default 0.
33 ``GMX_MAXBACKUP``
34         |Gromacs| automatically backs up old
35         copies of files when trying to write a new file of the same
36         name, and this variable controls the maximum number of
37         backups that will be made, default 99. If set to 0 it fails to
38         run if any output file already exists. And if set to -1 it
39         overwrites any output file without making a backup.
41 ``GMX_NO_QUOTES``
42         if this is explicitly set, no cool quotes
43         will be printed at the end of a program.
45 ``GMX_SUPPRESS_DUMP``
46         prevent dumping of step files during
47         (for example) blowing up during failure of constraint
48         algorithms.
50 ``GMX_TPI_DUMP``
51         dump all configurations to a :ref:`pdb`
52         file that have an interaction energy less than the value set
53         in this environment variable.
55 ``GMX_VIEW_XPM``
56         ``GMX_VIEW_XVG``, ``GMX_VIEW_EPS`` and ``GMX_VIEW_PDB``, commands used to
57         automatically view :ref:`xvg`, :ref:`xpm`, :ref:`eps`
58         and :ref:`pdb` file types, respectively; they default to ``xv``, ``xmgrace``,
59         ``ghostview`` and ``rasmol``. Set to empty to disable
60         automatic viewing of a particular file type. The command will
61         be forked off and run in the background at the same priority
62         as the |Gromacs| tool (which might not be what you want).
63         Be careful not to use a command which blocks the terminal
64         (e.g. ``vi``), since multiple instances might be run.
66 ``GMX_LOG_BUFFER``
67         the size of the buffer for file I/O. When set
68         to 0, all file I/O will be unbuffered and therefore very slow.
69         This can be handy for debugging purposes, because it ensures
70         that all files are always totally up-to-date.
72 ``GMX_LOGO_COLOR``
73         set display color for logo in :ref:`gmx view`.
75 ``GMX_PRINT_LONGFORMAT``
76         use long float format when printing
77         decimal values.
79 ``GMX_COMPELDUMP``
80         Applies for computational electrophysiology setups
81         only (see reference manual). The initial structure gets dumped to
82         :ref:`pdb` file, which allows to check whether multimeric channels have
83         the correct PBC representation.
85 ``GMX_TRAJECTORY_IO_VERBOSITY``
86         Defaults to 1, which prints frame count e.g. when reading trajectory
87         files. Set to 0 for quiet operation.
89 ``GMX_ENABLE_GPU_TIMING``
90         Enables GPU timings in the log file for CUDA. Note that CUDA timings
91         are incorrect with multiple streams, as happens with domain
92         decomposition or with both non-bondeds and PME on the GPU (this is
93         also the main reason why they are not turned on by default).
95 ``GMX_DISABLE_GPU_TIMING``
96         Disables GPU timings in the log file for OpenCL.
98 Debugging
99 ---------
100 ``GMX_PRINT_DEBUG_LINES``
101         when set, print debugging info on line numbers.
103 ``GMX_DD_NST_DUMP``
104         number of steps that elapse between dumping
105         the current DD to a PDB file (default 0). This only takes effect
106         during domain decomposition, so it should typically be
107         0 (never), 1 (every DD phase) or a multiple of :mdp:`nstlist`.
109 ``GMX_DD_NST_DUMP_GRID``
110         number of steps that elapse between dumping
111         the current DD grid to a PDB file (default 0). This only takes effect
112         during domain decomposition, so it should typically be
113         0 (never), 1 (every DD phase) or a multiple of :mdp:`nstlist`.
115 ``GMX_DD_DEBUG``
116         general debugging trigger for every domain
117         decomposition (default 0, meaning off). Currently only checks
118         global-local atom index mapping for consistency.
120 ``GMX_DD_NPULSE``
121         over-ride the number of DD pulses used
122         (default 0, meaning no over-ride). Normally 1 or 2.
124 ``GMX_DISABLE_ALTERNATING_GPU_WAIT``
125         disables the specialized polling wait path used to wait for the PME and nonbonded
126         GPU tasks completion to overlap to do the reduction of the resulting forces that
127         arrive first. Setting this variable switches to the generic path with fixed waiting
128         order.
130 There are a number of extra environment variables like these
131 that are used in debugging - check the code!
133 Performance and Run Control
134 ---------------------------
135 ``GMX_DO_GALACTIC_DYNAMICS``
136         planetary simulations are made possible (just for fun) by setting
137         this environment variable, which allows setting :mdp:`epsilon-r` to -1 in the :ref:`mdp`
138         file. Normally, :mdp:`epsilon-r` must be greater than zero to prevent a fatal error.
139         See webpage_ for example input files for a planetary simulation.
141 ``GMX_BONDED_NTHREAD_UNIFORM``
142         Value of the number of threads per rank from which to switch from uniform
143         to localized bonded interaction distribution; optimal value dependent on
144         system and hardware, default value is 4.
146 ``GMX_CUDA_NB_EWALD_TWINCUT``
147         force the use of twin-range cutoff kernel even if :mdp:`rvdw` equals
148         :mdp:`rcoulomb` after PP-PME load balancing. The switch to twin-range kernels is automated,
149         so this variable should be used only for benchmarking.
151 ``GMX_CUDA_NB_ANA_EWALD``
152         force the use of analytical Ewald kernels. Should be used only for benchmarking.
154 ``GMX_CUDA_NB_TAB_EWALD``
155         force the use of tabulated Ewald kernels. Should be used only for benchmarking.
157 ``GMX_DISABLE_CUDA_TIMING``
158         Deprecated. Use ``GMX_DISABLE_GPU_TIMING`` instead.
160 ``GMX_CYCLE_ALL``
161         times all code during runs.  Incompatible with threads.
163 ``GMX_CYCLE_BARRIER``
164         calls MPI_Barrier before each cycle start/stop call.
166 ``GMX_DD_ORDER_ZYX``
167         build domain decomposition cells in the order
168         (z, y, x) rather than the default (x, y, z).
170 ``GMX_DD_USE_SENDRECV2``
171         during constraint and vsite communication, use a pair
172         of ``MPI_Sendrecv`` calls instead of two simultaneous non-blocking calls
173         (default 0, meaning off). Might be faster on some MPI implementations.
175 ``GMX_DLB_BASED_ON_FLOPS``
176         do domain-decomposition dynamic load balancing based on flop count rather than
177         measured time elapsed (default 0, meaning off).
178         This makes the load balancing reproducible, which can be useful for debugging purposes.
179         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.
181 ``GMX_DLB_MAX_BOX_SCALING``
182         maximum percentage box scaling permitted per domain-decomposition
183         load-balancing step (default 10)
185 ``GMX_DD_RECORD_LOAD``
186         record DD load statistics for reporting at end of the run (default 1, meaning on)
188 ``GMX_DETAILED_PERF_STATS``
189         when set, print slightly more detailed performance information
190         to the :ref:`log` file. The resulting output is the way performance summary is reported in versions
191         4.5.x and thus may be useful for anyone using scripts to parse :ref:`log` files or standard output.
193 ``GMX_DISABLE_SIMD_KERNELS``
194         disables architecture-specific SIMD-optimized (SSE2, SSE4.1, AVX, etc.)
195         non-bonded kernels thus forcing the use of plain C kernels.
197 ``GMX_DISABLE_GPU_TIMING``
198         timing of asynchronously executed GPU operations can have a
199         non-negligible overhead with short step times. Disabling timing can improve performance in these cases.
201 ``GMX_DISABLE_GPU_DETECTION``
202         when set, disables GPU detection even if :ref:`gmx mdrun` was compiled
203         with GPU support.
205 ``GMX_GPU_APPLICATION_CLOCKS``
206         setting this variable to a value of "0", "ON", or "DISABLE" (case insensitive)
207         allows disabling the CUDA GPU allication clock support.
209 ``GMX_DISRE_ENSEMBLE_SIZE``
210         the number of systems for distance restraint ensemble
211         averaging. Takes an integer value.
213 ``GMX_EMULATE_GPU``
214         emulate GPU runs by using algorithmically equivalent CPU reference code instead of
215         GPU-accelerated functions. As the CPU code is slow, it is intended to be used only for debugging purposes.
217 ``GMX_ENX_NO_FATAL``
218         disable exiting upon encountering a corrupted frame in an :ref:`edr`
219         file, allowing the use of all frames up until the corruption.
221 ``GMX_FORCE_UPDATE``
222         update forces when invoking ``mdrun -rerun``.
224 ``GMX_GPU_ID``
225         set in the same way as ``mdrun -gpu_id``, ``GMX_GPU_ID``
226         allows the user to specify different GPU IDs for different ranks, which can be useful for selecting different
227         devices on different compute nodes in a cluster.  Cannot be used in conjunction with ``mdrun -gpu_id``.
229 ``GMX_GPUTASKS``
230         set in the same way as ``mdrun -gputasks``, ``GMX_GPUTASKS`` allows the mapping
231         of GPU tasks to GPU device IDs to be different on different ranks, if e.g. the MPI
232         runtime permits this variable to be different for different ranks. Cannot be used
233         in conjunction with ``mdrun -gputasks``. Has all the same requirements as ``mdrun -gputasks``.
235 ``GMX_IGNORE_FSYNC_FAILURE_ENV``
236         allow :ref:`gmx mdrun` to continue even if
237         a file is missing.
239 ``GMX_LJCOMB_TOL``
240         when set to a floating-point value, overrides the default tolerance of
241         1e-5 for force-field floating-point parameters.
243 ``GMX_MAXCONSTRWARN``
244         if set to -1, :ref:`gmx mdrun` will
245         not exit if it produces too many LINCS warnings.
247 ``GMX_NB_MIN_CI``
248         neighbor list balancing parameter used when running on GPU. Sets the
249         target minimum number pair-lists in order to improve multi-processor load-balance for better
250         performance with small simulation systems. Must be set to a non-negative integer,
251         the 0 value disables list splitting.
252         The default value is optimized for supported GPUs
253         therefore changing it is not necessary for normal usage, but it can be useful on future architectures.
255 ``GMX_NBLISTCG``
256         use neighbor list and kernels based on charge groups.
258 ``GMX_NBNXN_CYCLE``
259         when set, print detailed neighbor search cycle counting.
261 ``GMX_NBNXN_EWALD_ANALYTICAL``
262         force the use of analytical Ewald non-bonded kernels,
263         mutually exclusive of ``GMX_NBNXN_EWALD_TABLE``.
265 ``GMX_NBNXN_EWALD_TABLE``
266         force the use of tabulated Ewald non-bonded kernels,
267         mutually exclusive of ``GMX_NBNXN_EWALD_ANALYTICAL``.
269 ``GMX_NBNXN_SIMD_2XNN``
270         force the use of 2x(N+N) SIMD CPU non-bonded kernels,
271         mutually exclusive of ``GMX_NBNXN_SIMD_4XN``.
273 ``GMX_NBNXN_SIMD_4XN``
274         force the use of 4xN SIMD CPU non-bonded kernels,
275         mutually exclusive of ``GMX_NBNXN_SIMD_2XNN``.
277 ``GMX_NOOPTIMIZEDKERNELS``
278         deprecated, use ``GMX_DISABLE_SIMD_KERNELS`` instead.
280 ``GMX_NO_CART_REORDER``
281         used in initializing domain decomposition communicators. Rank reordering
282         is default, but can be switched off with this environment variable.
284 ``GMX_NO_LJ_COMB_RULE``
285         force the use of LJ paremeter lookup instead of using combination rules
286         in the non-bonded kernels.
288 ``GMX_NO_INT``, ``GMX_NO_TERM``, ``GMX_NO_USR1``
289         disable signal handlers for SIGINT,
290         SIGTERM, and SIGUSR1, respectively.
292 ``GMX_NO_NODECOMM``
293         do not use separate inter- and intra-node communicators.
295 ``GMX_NO_NONBONDED``
296         skip non-bonded calculations; can be used to estimate the possible
297         performance gain from adding a GPU accelerator to the current hardware setup -- assuming that this is
298         fast enough to complete the non-bonded calculations while the CPU does bonded force and PME computation.
299         Freezing the particles will be required to stop the system blowing up.
301 ``GMX_PULL_PARTICIPATE_ALL``
302         disable the default heuristic for when to use a separate pull MPI communicator (at >=32 ranks).
304 ``GMX_NOPREDICT``
305         shell positions are not predicted.
307 ``GMX_NO_UPDATEGROUPS``
308         turns off update groups. May allow for a decomposition of more
309         domains for small systems at the cost of communication during update.
311 ``GMX_NSCELL_NCG``
312         the ideal number of charge groups per neighbor searching grid cell is hard-coded
313         to a value of 10. Setting this environment variable to any other integer value overrides this hard-coded
314         value.
316 ``GMX_PME_NUM_THREADS``
317         set the number of OpenMP or PME threads; overrides the default set by
318         :ref:`gmx mdrun`; can be used instead of the `-npme` command line option,
319         also useful to set heterogeneous per-process/-node thread count.
321 ``GMX_PME_P3M``
322         use P3M-optimized influence function instead of smooth PME B-spline interpolation.
324 ``GMX_PME_THREAD_DIVISION``
325         PME thread division in the format "x y z" for all three dimensions. The
326         sum of the threads in each dimension must equal the total number of PME threads (set in
327         `GMX_PME_NTHREADS`).
329 ``GMX_PMEONEDD``
330         if the number of domain decomposition cells is set to 1 for both x and y,
331         decompose PME in one dimension.
333 ``GMX_REQUIRE_SHELL_INIT``
334         require that shell positions are initiated.
336 ``GMX_REQUIRE_TABLES``
337         require the use of tabulated Coulombic
338         and van der Waals interactions.
340 ``GMX_SCSIGMA_MIN``
341         the minimum value for soft-core sigma. **Note** that this value is set
342         using the :mdp:`sc-sigma` keyword in the :ref:`mdp` file, but this environment variable can be used
343         to reproduce pre-4.5 behavior with respect to this parameter.
345 ``GMX_TPIC_MASSES``
346         should contain multiple masses used for test particle insertion into a cavity.
347         The center of mass of the last atoms is used for insertion into the cavity.
349 ``GMX_USE_GRAPH``
350         use graph for bonded interactions.
352 ``GMX_VERLET_BUFFER_RES``
353         resolution of buffer size in Verlet cutoff scheme.  The default value is
354         0.001, but can be overridden with this environment variable.
356 ``HWLOC_XMLFILE``
357         Not strictly a |Gromacs| environment variable, but on large machines
358         the hwloc detection can take a few seconds if you have lots of MPI processes.
359         If you run the hwloc command `lstopo out.xml` and set this environment
360         variable to point to the location of this file, the hwloc library will use
361         the cached information instead, which can be faster.
363 ``MPIRUN``
364         the ``mpirun`` command used by :ref:`gmx tune_pme`.
366 ``MDRUN``
367         the :ref:`gmx mdrun` command used by :ref:`gmx tune_pme`.
369 ``GMX_DISABLE_DYNAMICPRUNING``
370         disables dynamic pair-list pruning. Note that :ref:`gmx mdrun` will
371         still tune nstlist to the optimal value picked assuming dynamic pruning. Thus
372         for good performance the -nstlist option should be used.
374 ``GMX_NSTLIST_DYNAMICPRUNING``
375         overrides the dynamic pair-list pruning interval chosen heuristically
376         by mdrun. Values should be between the pruning frequency value
377         (1 for CPU and 2 for GPU) and :mdp:`nstlist` ``- 1``.
379 ``GMX_USE_TREEREDUCE``
380         use tree reduction for nbnxn force reduction. Potentially faster for large number of
381         OpenMP threads (if memory locality is important).
383 .. _opencl-management:
385 OpenCL management
386 -----------------
387 Currently, several environment variables exist that help customize some aspects
388 of the OpenCL_ version of |Gromacs|. They are mostly related to the runtime
389 compilation of OpenCL kernels, but they are also used in device selection.
391 ``GMX_OCL_NOGENCACHE``
392         If set, disable caching for OpenCL kernel builds. Caching is
393         normally useful so that future runs can re-use the compiled
394         kernels from previous runs. Currently, caching is always
395         disabled, until we solve concurrency issues.
397 ``GMX_OCL_GENCACHE``
398         Enable OpenCL binary caching. Only intended to be used for
399         development and (expert) testing as neither concurrency
400         nor cache invalidation is implemented safely!
402 ``GMX_OCL_NOFASTGEN``
403         If set, generate and compile all algorithm flavors, otherwise
404         only the flavor required for the simulation is generated and
405         compiled.
407 ``GMX_OCL_DISABLE_FASTMATH``
408         Prevents the use of ``-cl-fast-relaxed-math`` compiler option.
410 ``GMX_OCL_DUMP_LOG``
411         If defined, the OpenCL build log is always written to the
412         mdrun log file. Otherwise, the build log is written to the
413         log file only when an error occurs.
415 ``GMX_OCL_VERBOSE``
416         If defined, it enables verbose mode for OpenCL kernel build.
417         Currently available only for NVIDIA GPUs. See ``GMX_OCL_DUMP_LOG``
418         for details about how to obtain the OpenCL build log.
420 ``GMX_OCL_DUMP_INTERM_FILES``
422         If defined, intermediate language code corresponding to the
423         OpenCL build process is saved to file. Caching has to be
424         turned off in order for this option to take effect (see
425         ``GMX_OCL_NOGENCACHE``).
427             - NVIDIA GPUs: PTX code is saved in the current directory
428               with the name ``device_name.ptx``
429             - AMD GPUs: ``.IL/.ISA`` files will be created for each OpenCL
430               kernel built.  For details about where these files are
431               created check AMD documentation for ``-save-temps`` compiler
432               option.
434 ``GMX_OCL_DEBUG``
435         Use in conjunction with ``OCL_FORCE_CPU`` or with an AMD device.
436         It adds the debug flag to the compiler options (-g).
438 ``GMX_OCL_NOOPT``
439         Disable optimisations. Adds the option ``cl-opt-disable`` to the
440         compiler options.
442 ``GMX_OCL_FORCE_CPU``
443         Force the selection of a CPU device instead of a GPU.  This
444         exists only for debugging purposes. Do not expect |Gromacs| to
445         function properly with this option on, it is solely for the
446         simplicity of stepping in a kernel and see what is happening.
448 ``GMX_OCL_DISABLE_I_PREFETCH``
449         Disables i-atom data (type or LJ parameter) prefetch allowing
450         testing.
452 ``GMX_OCL_ENABLE_I_PREFETCH``
453         Enables i-atom data (type or LJ parameter) prefetch allowing
454         testing on platforms where this behavior is not default.
456 ``GMX_OCL_NB_ANA_EWALD``
457         Forces the use of analytical Ewald kernels. Equivalent of
458         CUDA environment variable ``GMX_CUDA_NB_ANA_EWALD``
460 ``GMX_OCL_NB_TAB_EWALD``
461         Forces the use of tabulated Ewald kernel. Equivalent
462         of CUDA environment variable ``GMX_OCL_NB_TAB_EWALD``
464 ``GMX_OCL_NB_EWALD_TWINCUT``
465         Forces the use of twin-range cutoff kernel. Equivalent of
466         CUDA environment variable ``GMX_CUDA_NB_EWALD_TWINCUT``
468 ``GMX_OCL_FILE_PATH``
469         Use this parameter to force |Gromacs| to load the OpenCL
470         kernels from a custom location. Use it only if you want to
471         override |Gromacs| default behavior, or if you want to test
472         your own kernels.
474 ``GMX_OCL_DISABLE_COMPATIBILITY_CHECK``
475         Disables the hardware compatibility check. Useful for developers
476         and allows testing the OpenCL kernels on non-supported platforms
477         (like Intel iGPUs) without source code modification.
479 ``GMX_OCL_SHOW_DIAGNOSTICS``
480         Use Intel OpenCL extension to show additional runtime performance
481         diagnostics.
483 Analysis and Core Functions
484 ---------------------------
485 ``GMX_QM_ACCURACY``
486         accuracy in Gaussian L510 (MC-SCF) component program.
488 ``GMX_QM_ORCA_BASENAME``
489         prefix of :ref:`tpr` files, used in Orca calculations
490         for input and output file names.
492 ``GMX_QM_CPMCSCF``
493         when set to a nonzero value, Gaussian QM calculations will
494         iteratively solve the CP-MCSCF equations.
496 ``GMX_QM_MODIFIED_LINKS_DIR``
497         location of modified links in Gaussian.
499 ``DSSP``
500         used by :ref:`gmx do_dssp` to point to the ``dssp``
501         executable (not just its path).
503 ``GMX_QM_GAUSS_DIR``
504         directory where Gaussian is installed.
506 ``GMX_QM_GAUSS_EXE``
507         name of the Gaussian executable.
509 ``GMX_DIPOLE_SPACING``
510         spacing used by :ref:`gmx dipoles`.
512 ``GMX_MAXRESRENUM``
513         sets the maximum number of residues to be renumbered by
514         :ref:`gmx grompp`. A value of -1 indicates all residues should be renumbered.
516 ``GMX_NO_FFRTP_TER_RENAME``
517         Some force fields (like AMBER) use specific names for N- and C-
518         terminal residues (NXXX and CXXX) as :ref:`rtp` entries that are normally renamed. Setting
519         this environment variable disables this renaming.
521 ``GMX_PATH_GZIP``
522         ``gunzip`` executable, used by :ref:`gmx wham`.
524 ``GMX_FONT``
525         name of X11 font used by :ref:`gmx view`.
527 ``GMXTIMEUNIT``
528         the time unit used in output files, can be
529         anything in fs, ps, ns, us, ms, s, m or h.
531 ``GMX_QM_GAUSSIAN_MEMORY``
532         memory used for Gaussian QM calculation.
534 ``MULTIPROT``
535         name of the ``multiprot`` executable, used by the
536         contributed program ``do_multiprot``.
538 ``NCPUS``
539         number of CPUs to be used for Gaussian QM calculation
541 ``GMX_ORCA_PATH``
542         directory where Orca is installed.
544 ``GMX_QM_SA_STEP``
545         simulated annealing step size for Gaussian QM calculation.
547 ``GMX_QM_GROUND_STATE``
548         defines state for Gaussian surface hopping calculation.
550 ``GMX_TOTAL``
551         name of the ``total`` executable used by the contributed
552         ``do_shift`` program.
554 ``GMX_ENER_VERBOSE``
555         make :ref:`gmx energy` and :ref:`gmx eneconv`
556         loud and noisy.
558 ``VMD_PLUGIN_PATH``
559         where to find VMD plug-ins. Needed to be
560         able to read file formats recognized only by a VMD plug-in.
562 ``VMDDIR``
563         base path of VMD installation.
565 ``GMX_USE_XMGR``
566         sets viewer to ``xmgr`` (deprecated) instead of ``xmgrace``.