Home › The command line
The command line
Running the same engine without the window: single calculations, batches, figures and crystal analysis from a script.
geindft.exe runs the same engine as the desktop application, with the same settings and the same output files. It is the right tool for a series of molecules, for a machine with no display, and for anything that has to be repeatable from a script.
The commands
| Command | Purpose |
|---|---|
run | Run a calculation on one structure or job file. |
batch | Run every structure in a directory. |
esp | The electrostatic potential surface and its statistics. |
render | Render a figure from a finished wavefunction. |
ligand | Optimise ligands with the MMFF94 force field. |
crystal | Crystal analysis: molecules, contacts, Hirshfeld surfaces and fingerprints. |
convert | Convert a structure between formats. |
info | Describe a structure file. |
basis, functionals, formats | List what is available. |
Everyday examples
geindft run aspirin.xyz
geindft run aspirin.xyz --method B3LYP --basis def2-TZVP --opt --esp --orbitals 3
geindft run radical.xyz --mult 2 --esp
geindft batch ./structures --method PBE0 --basis def2-SVP
geindft convert drug.smi drug.sdf
geindft info crystal.cif
Figures from a finished calculation
geindft render result.gwfn --orbital HOMO --png homo.png
geindft render result.gwfn --orbital LUMO --dpi 600 --width 4800 --png lumo.png
geindft render result.gwfn --esp --png esp.png
geindft render result.gwfn --esp --all-extrema --png esp_all.png
geindft render result.gwfn --orbital HOMO --colors orange-teal --png homo_cvd.png
Those figures are produced without a display, which means they can be generated on a server as part of a pipeline.
Options worth knowing
| Option | Effect |
|---|---|
--opt, --freq, --ts | Optimise, compute frequencies, or search for a transition state. |
--accuracy | screening, normal, tight or verytight. Sets the grid and the convergence criteria together. |
--esp, --density, --orbitals N, --fukui | Which fields to produce. |
--charge, --mult | Charge and spin multiplicity. |
--solvent | An implicit solvent model. |
--report DIR | Write a self-contained HTML report of the calculation. |
--json | Emit a machine-readable result, for scripting. |
-j N | Worker threads. The result does not depend on this number. |
--no-3d | Keep coordinates exactly as read, instead of building three-dimensional ones for flat or SMILES input. |
-o DIR, -n NAME | Where results go and what they are called. |
Every command accepts
--help, which lists its options with their defaults. The job file written by a run, <name>.gin, can be edited and given straight back to geindft run, which is the simplest way to repeat a calculation with one setting changed.