Skip to content

Commit b0d1033

Browse files
committed
[doc] document env-var substitution in dft_exec commands
The dft_exec command strings are expanded with str.format against os.environ in addition to {number_cores}, so {HOME}, {SLURM_NTASKS}, ... work too. This was supported but only {number_cores} was documented.
1 parent e805419 commit b0d1033

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

python/solid_dmft/io_tools/documentation.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -491,7 +491,8 @@ dft_exec : string or table, default = 'vasp_std'
491491
* ``win`` — wannier90.x command (default: 'wannier90.x')
492492

493493
Use ``{number_cores}`` as a placeholder in commands, it will be replaced
494-
with the value of ``n_cores``.
494+
with the value of ``n_cores``. Environment variables can be used the same
495+
way, e.g. ``{HOME}`` or ``{SLURM_NTASKS}``, and are expanded at run time.
495496
mpi_env : string, default = 'default'
496497
selection for mpi env for DFT / VASP in default this will only call VASP as mpirun -np n_cores_dft dft_exec
497498
Possible values:

0 commit comments

Comments
 (0)