Advanced Usage
In this tutorial we will continue from the job created in the Basic Tutorial, and demonstrate some more advanced functionality that DFControl offers.
To load a previously saved job we here provide a valid job directory with a job.sh script in it.
using DFControl
job = load(Servers.local_server(), Job("job"))+--------------JOB------------+
| name: Si |
| dir: job |
| version: 0 |
| server: fv-az459-912, alive |
| versions: 0 |
| state: Unknown |
+-------------------------------+
(scheduled, not scheduled)
scf
bands
Since the job created in the Basic Tutorial was saved in the "job" directory this will work, see the section on Jobs for further details and options on how to load previously saved jobs.
The next thing we may want to do is to change the directory where the job is running.
job.dir = "Job2"+--------------------------------------------JOB------------------------------------------+
| name: Si |
| dir: /home/runner/work/DFControl.jl/DFControl.jl/src/../docs/src/assets/Job2 |
| version: 0 |
| server: fv-az459-912, alive |
| versions: 0 |
| last submission: 2022-09-23T07:00:24 |
| state: Unknown |
+-------------------------------------------------------------------------------------------+
(scheduled, not scheduled)
scf
bands
With the copy=true flag we let DFControl know that not only to create and set the new directory, but also to copy the previous results and temporary files to the new directory so we don't have to rerun the scf calculation.
Next we would like to plot the projected density of states. For that we create both an nscf calculation to get a uniform k-grid, and projwfc calculation.
push!(job, Calculations.gencalc_nscf(job["scf"], (6, 6, 6)))3-element Vector{Calculation}:
Calculation{QE}:
name = scf
exec = pw.x
run = false
data = [:k_points]
flags:
&control
calculation => scf
&system
ecutwfc => 20.0
&electrons
conv_thr => 1.0e-6
Calculation{QE}:
name = bands
exec = pw.x
run = true
data = [:k_points]
flags:
&control
verbosity => high
calculation => bands
&system
ecutwfc => 20.0
&electrons
conv_thr => 1.0e-6
Calculation{QE}:
name = nscf
exec = pw.x
run = false
data = [:k_points]
flags:
&control
verbosity => high
calculation => nscf
&system
ecutwfc => 20.0
&electrons
conv_thr => 1.0e-6
The second argument of gencalc_nscf is the kgrid. When passing a 3-Tuple, the code will assume that an explicit k-grid is requested, which can be verified by
data(job["nscf"], :k_points)Block name: k_points
Block option: crystal
Block data:
[(0.0, 0.0, 0.0, 0.004629629629629629), (0.16666666666666666, 0.0, 0.0, 0.004629629629629629), (0.3333333333333333, 0.0, 0.0, 0.004629629629629629), (0.5, 0.0, 0.0, 0.004629629629629629), (0.6666666666666666, 0.0, 0.0, 0.004629629629629629), (0.8333333333333334, 0.0, 0.0, 0.004629629629629629), (0.0, 0.16666666666666666, 0.0, 0.004629629629629629), (0.16666666666666666, 0.16666666666666666, 0.0, 0.004629629629629629), (0.3333333333333333, 0.16666666666666666, 0.0, 0.004629629629629629), (0.5, 0.16666666666666666, 0.0, 0.004629629629629629), (0.6666666666666666, 0.16666666666666666, 0.0, 0.004629629629629629), (0.8333333333333334, 0.16666666666666666, 0.0, 0.004629629629629629), (0.0, 0.3333333333333333, 0.0, 0.004629629629629629), (0.16666666666666666, 0.3333333333333333, 0.0, 0.004629629629629629), (0.3333333333333333, 0.3333333333333333, 0.0, 0.004629629629629629), (0.5, 0.3333333333333333, 0.0, 0.004629629629629629), (0.6666666666666666, 0.3333333333333333, 0.0, 0.004629629629629629), (0.8333333333333334, 0.3333333333333333, 0.0, 0.004629629629629629), (0.0, 0.5, 0.0, 0.004629629629629629), (0.16666666666666666, 0.5, 0.0, 0.004629629629629629), (0.3333333333333333, 0.5, 0.0, 0.004629629629629629), (0.5, 0.5, 0.0, 0.004629629629629629), (0.6666666666666666, 0.5, 0.0, 0.004629629629629629), (0.8333333333333334, 0.5, 0.0, 0.004629629629629629), (0.0, 0.6666666666666666, 0.0, 0.004629629629629629), (0.16666666666666666, 0.6666666666666666, 0.0, 0.004629629629629629), (0.3333333333333333, 0.6666666666666666, 0.0, 0.004629629629629629), (0.5, 0.6666666666666666, 0.0, 0.004629629629629629), (0.6666666666666666, 0.6666666666666666, 0.0, 0.004629629629629629), (0.8333333333333334, 0.6666666666666666, 0.0, 0.004629629629629629), (0.0, 0.8333333333333334, 0.0, 0.004629629629629629), (0.16666666666666666, 0.8333333333333334, 0.0, 0.004629629629629629), (0.3333333333333333, 0.8333333333333334, 0.0, 0.004629629629629629), (0.5, 0.8333333333333334, 0.0, 0.004629629629629629), (0.6666666666666666, 0.8333333333333334, 0.0, 0.004629629629629629), (0.8333333333333334, 0.8333333333333334, 0.0, 0.004629629629629629), (0.0, 0.0, 0.16666666666666666, 0.004629629629629629), (0.16666666666666666, 0.0, 0.16666666666666666, 0.004629629629629629), (0.3333333333333333, 0.0, 0.16666666666666666, 0.004629629629629629), (0.5, 0.0, 0.16666666666666666, 0.004629629629629629), (0.6666666666666666, 0.0, 0.16666666666666666, 0.004629629629629629), (0.8333333333333334, 0.0, 0.16666666666666666, 0.004629629629629629), (0.0, 0.16666666666666666, 0.16666666666666666, 0.004629629629629629), (0.16666666666666666, 0.16666666666666666, 0.16666666666666666, 0.004629629629629629), (0.3333333333333333, 0.16666666666666666, 0.16666666666666666, 0.004629629629629629), (0.5, 0.16666666666666666, 0.16666666666666666, 0.004629629629629629), (0.6666666666666666, 0.16666666666666666, 0.16666666666666666, 0.004629629629629629), (0.8333333333333334, 0.16666666666666666, 0.16666666666666666, 0.004629629629629629), (0.0, 0.3333333333333333, 0.16666666666666666, 0.004629629629629629), (0.16666666666666666, 0.3333333333333333, 0.16666666666666666, 0.004629629629629629), (0.3333333333333333, 0.3333333333333333, 0.16666666666666666, 0.004629629629629629), (0.5, 0.3333333333333333, 0.16666666666666666, 0.004629629629629629), (0.6666666666666666, 0.3333333333333333, 0.16666666666666666, 0.004629629629629629), (0.8333333333333334, 0.3333333333333333, 0.16666666666666666, 0.004629629629629629), (0.0, 0.5, 0.16666666666666666, 0.004629629629629629), (0.16666666666666666, 0.5, 0.16666666666666666, 0.004629629629629629), (0.3333333333333333, 0.5, 0.16666666666666666, 0.004629629629629629), (0.5, 0.5, 0.16666666666666666, 0.004629629629629629), (0.6666666666666666, 0.5, 0.16666666666666666, 0.004629629629629629), (0.8333333333333334, 0.5, 0.16666666666666666, 0.004629629629629629), (0.0, 0.6666666666666666, 0.16666666666666666, 0.004629629629629629), (0.16666666666666666, 0.6666666666666666, 0.16666666666666666, 0.004629629629629629), (0.3333333333333333, 0.6666666666666666, 0.16666666666666666, 0.004629629629629629), (0.5, 0.6666666666666666, 0.16666666666666666, 0.004629629629629629), (0.6666666666666666, 0.6666666666666666, 0.16666666666666666, 0.004629629629629629), (0.8333333333333334, 0.6666666666666666, 0.16666666666666666, 0.004629629629629629), (0.0, 0.8333333333333334, 0.16666666666666666, 0.004629629629629629), (0.16666666666666666, 0.8333333333333334, 0.16666666666666666, 0.004629629629629629), (0.3333333333333333, 0.8333333333333334, 0.16666666666666666, 0.004629629629629629), (0.5, 0.8333333333333334, 0.16666666666666666, 0.004629629629629629), (0.6666666666666666, 0.8333333333333334, 0.16666666666666666, 0.004629629629629629), (0.8333333333333334, 0.8333333333333334, 0.16666666666666666, 0.004629629629629629), (0.0, 0.0, 0.3333333333333333, 0.004629629629629629), (0.16666666666666666, 0.0, 0.3333333333333333, 0.004629629629629629), (0.3333333333333333, 0.0, 0.3333333333333333, 0.004629629629629629), (0.5, 0.0, 0.3333333333333333, 0.004629629629629629), (0.6666666666666666, 0.0, 0.3333333333333333, 0.004629629629629629), (0.8333333333333334, 0.0, 0.3333333333333333, 0.004629629629629629), (0.0, 0.16666666666666666, 0.3333333333333333, 0.004629629629629629), (0.16666666666666666, 0.16666666666666666, 0.3333333333333333, 0.004629629629629629), (0.3333333333333333, 0.16666666666666666, 0.3333333333333333, 0.004629629629629629), (0.5, 0.16666666666666666, 0.3333333333333333, 0.004629629629629629), (0.6666666666666666, 0.16666666666666666, 0.3333333333333333, 0.004629629629629629), (0.8333333333333334, 0.16666666666666666, 0.3333333333333333, 0.004629629629629629), (0.0, 0.3333333333333333, 0.3333333333333333, 0.004629629629629629), (0.16666666666666666, 0.3333333333333333, 0.3333333333333333, 0.004629629629629629), (0.3333333333333333, 0.3333333333333333, 0.3333333333333333, 0.004629629629629629), (0.5, 0.3333333333333333, 0.3333333333333333, 0.004629629629629629), (0.6666666666666666, 0.3333333333333333, 0.3333333333333333, 0.004629629629629629), (0.8333333333333334, 0.3333333333333333, 0.3333333333333333, 0.004629629629629629), (0.0, 0.5, 0.3333333333333333, 0.004629629629629629), (0.16666666666666666, 0.5, 0.3333333333333333, 0.004629629629629629), (0.3333333333333333, 0.5, 0.3333333333333333, 0.004629629629629629), (0.5, 0.5, 0.3333333333333333, 0.004629629629629629), (0.6666666666666666, 0.5, 0.3333333333333333, 0.004629629629629629), (0.8333333333333334, 0.5, 0.3333333333333333, 0.004629629629629629), (0.0, 0.6666666666666666, 0.3333333333333333, 0.004629629629629629), (0.16666666666666666, 0.6666666666666666, 0.3333333333333333, 0.004629629629629629), (0.3333333333333333, 0.6666666666666666, 0.3333333333333333, 0.004629629629629629), (0.5, 0.6666666666666666, 0.3333333333333333, 0.004629629629629629), (0.6666666666666666, 0.6666666666666666, 0.3333333333333333, 0.004629629629629629), (0.8333333333333334, 0.6666666666666666, 0.3333333333333333, 0.004629629629629629), (0.0, 0.8333333333333334, 0.3333333333333333, 0.004629629629629629), (0.16666666666666666, 0.8333333333333334, 0.3333333333333333, 0.004629629629629629), (0.3333333333333333, 0.8333333333333334, 0.3333333333333333, 0.004629629629629629), (0.5, 0.8333333333333334, 0.3333333333333333, 0.004629629629629629), (0.6666666666666666, 0.8333333333333334, 0.3333333333333333, 0.004629629629629629), (0.8333333333333334, 0.8333333333333334, 0.3333333333333333, 0.004629629629629629), (0.0, 0.0, 0.5, 0.004629629629629629), (0.16666666666666666, 0.0, 0.5, 0.004629629629629629), (0.3333333333333333, 0.0, 0.5, 0.004629629629629629), (0.5, 0.0, 0.5, 0.004629629629629629), (0.6666666666666666, 0.0, 0.5, 0.004629629629629629), (0.8333333333333334, 0.0, 0.5, 0.004629629629629629), (0.0, 0.16666666666666666, 0.5, 0.004629629629629629), (0.16666666666666666, 0.16666666666666666, 0.5, 0.004629629629629629), (0.3333333333333333, 0.16666666666666666, 0.5, 0.004629629629629629), (0.5, 0.16666666666666666, 0.5, 0.004629629629629629), (0.6666666666666666, 0.16666666666666666, 0.5, 0.004629629629629629), (0.8333333333333334, 0.16666666666666666, 0.5, 0.004629629629629629), (0.0, 0.3333333333333333, 0.5, 0.004629629629629629), (0.16666666666666666, 0.3333333333333333, 0.5, 0.004629629629629629), (0.3333333333333333, 0.3333333333333333, 0.5, 0.004629629629629629), (0.5, 0.3333333333333333, 0.5, 0.004629629629629629), (0.6666666666666666, 0.3333333333333333, 0.5, 0.004629629629629629), (0.8333333333333334, 0.3333333333333333, 0.5, 0.004629629629629629), (0.0, 0.5, 0.5, 0.004629629629629629), (0.16666666666666666, 0.5, 0.5, 0.004629629629629629), (0.3333333333333333, 0.5, 0.5, 0.004629629629629629), (0.5, 0.5, 0.5, 0.004629629629629629), (0.6666666666666666, 0.5, 0.5, 0.004629629629629629), (0.8333333333333334, 0.5, 0.5, 0.004629629629629629), (0.0, 0.6666666666666666, 0.5, 0.004629629629629629), (0.16666666666666666, 0.6666666666666666, 0.5, 0.004629629629629629), (0.3333333333333333, 0.6666666666666666, 0.5, 0.004629629629629629), (0.5, 0.6666666666666666, 0.5, 0.004629629629629629), (0.6666666666666666, 0.6666666666666666, 0.5, 0.004629629629629629), (0.8333333333333334, 0.6666666666666666, 0.5, 0.004629629629629629), (0.0, 0.8333333333333334, 0.5, 0.004629629629629629), (0.16666666666666666, 0.8333333333333334, 0.5, 0.004629629629629629), (0.3333333333333333, 0.8333333333333334, 0.5, 0.004629629629629629), (0.5, 0.8333333333333334, 0.5, 0.004629629629629629), (0.6666666666666666, 0.8333333333333334, 0.5, 0.004629629629629629), (0.8333333333333334, 0.8333333333333334, 0.5, 0.004629629629629629), (0.0, 0.0, 0.6666666666666666, 0.004629629629629629), (0.16666666666666666, 0.0, 0.6666666666666666, 0.004629629629629629), (0.3333333333333333, 0.0, 0.6666666666666666, 0.004629629629629629), (0.5, 0.0, 0.6666666666666666, 0.004629629629629629), (0.6666666666666666, 0.0, 0.6666666666666666, 0.004629629629629629), (0.8333333333333334, 0.0, 0.6666666666666666, 0.004629629629629629), (0.0, 0.16666666666666666, 0.6666666666666666, 0.004629629629629629), (0.16666666666666666, 0.16666666666666666, 0.6666666666666666, 0.004629629629629629), (0.3333333333333333, 0.16666666666666666, 0.6666666666666666, 0.004629629629629629), (0.5, 0.16666666666666666, 0.6666666666666666, 0.004629629629629629), (0.6666666666666666, 0.16666666666666666, 0.6666666666666666, 0.004629629629629629), (0.8333333333333334, 0.16666666666666666, 0.6666666666666666, 0.004629629629629629), (0.0, 0.3333333333333333, 0.6666666666666666, 0.004629629629629629), (0.16666666666666666, 0.3333333333333333, 0.6666666666666666, 0.004629629629629629), (0.3333333333333333, 0.3333333333333333, 0.6666666666666666, 0.004629629629629629), (0.5, 0.3333333333333333, 0.6666666666666666, 0.004629629629629629), (0.6666666666666666, 0.3333333333333333, 0.6666666666666666, 0.004629629629629629), (0.8333333333333334, 0.3333333333333333, 0.6666666666666666, 0.004629629629629629), (0.0, 0.5, 0.6666666666666666, 0.004629629629629629), (0.16666666666666666, 0.5, 0.6666666666666666, 0.004629629629629629), (0.3333333333333333, 0.5, 0.6666666666666666, 0.004629629629629629), (0.5, 0.5, 0.6666666666666666, 0.004629629629629629), (0.6666666666666666, 0.5, 0.6666666666666666, 0.004629629629629629), (0.8333333333333334, 0.5, 0.6666666666666666, 0.004629629629629629), (0.0, 0.6666666666666666, 0.6666666666666666, 0.004629629629629629), (0.16666666666666666, 0.6666666666666666, 0.6666666666666666, 0.004629629629629629), (0.3333333333333333, 0.6666666666666666, 0.6666666666666666, 0.004629629629629629), (0.5, 0.6666666666666666, 0.6666666666666666, 0.004629629629629629), (0.6666666666666666, 0.6666666666666666, 0.6666666666666666, 0.004629629629629629), (0.8333333333333334, 0.6666666666666666, 0.6666666666666666, 0.004629629629629629), (0.0, 0.8333333333333334, 0.6666666666666666, 0.004629629629629629), (0.16666666666666666, 0.8333333333333334, 0.6666666666666666, 0.004629629629629629), (0.3333333333333333, 0.8333333333333334, 0.6666666666666666, 0.004629629629629629), (0.5, 0.8333333333333334, 0.6666666666666666, 0.004629629629629629), (0.6666666666666666, 0.8333333333333334, 0.6666666666666666, 0.004629629629629629), (0.8333333333333334, 0.8333333333333334, 0.6666666666666666, 0.004629629629629629), (0.0, 0.0, 0.8333333333333334, 0.004629629629629629), (0.16666666666666666, 0.0, 0.8333333333333334, 0.004629629629629629), (0.3333333333333333, 0.0, 0.8333333333333334, 0.004629629629629629), (0.5, 0.0, 0.8333333333333334, 0.004629629629629629), (0.6666666666666666, 0.0, 0.8333333333333334, 0.004629629629629629), (0.8333333333333334, 0.0, 0.8333333333333334, 0.004629629629629629), (0.0, 0.16666666666666666, 0.8333333333333334, 0.004629629629629629), (0.16666666666666666, 0.16666666666666666, 0.8333333333333334, 0.004629629629629629), (0.3333333333333333, 0.16666666666666666, 0.8333333333333334, 0.004629629629629629), (0.5, 0.16666666666666666, 0.8333333333333334, 0.004629629629629629), (0.6666666666666666, 0.16666666666666666, 0.8333333333333334, 0.004629629629629629), (0.8333333333333334, 0.16666666666666666, 0.8333333333333334, 0.004629629629629629), (0.0, 0.3333333333333333, 0.8333333333333334, 0.004629629629629629), (0.16666666666666666, 0.3333333333333333, 0.8333333333333334, 0.004629629629629629), (0.3333333333333333, 0.3333333333333333, 0.8333333333333334, 0.004629629629629629), (0.5, 0.3333333333333333, 0.8333333333333334, 0.004629629629629629), (0.6666666666666666, 0.3333333333333333, 0.8333333333333334, 0.004629629629629629), (0.8333333333333334, 0.3333333333333333, 0.8333333333333334, 0.004629629629629629), (0.0, 0.5, 0.8333333333333334, 0.004629629629629629), (0.16666666666666666, 0.5, 0.8333333333333334, 0.004629629629629629), (0.3333333333333333, 0.5, 0.8333333333333334, 0.004629629629629629), (0.5, 0.5, 0.8333333333333334, 0.004629629629629629), (0.6666666666666666, 0.5, 0.8333333333333334, 0.004629629629629629), (0.8333333333333334, 0.5, 0.8333333333333334, 0.004629629629629629), (0.0, 0.6666666666666666, 0.8333333333333334, 0.004629629629629629), (0.16666666666666666, 0.6666666666666666, 0.8333333333333334, 0.004629629629629629), (0.3333333333333333, 0.6666666666666666, 0.8333333333333334, 0.004629629629629629), (0.5, 0.6666666666666666, 0.8333333333333334, 0.004629629629629629), (0.6666666666666666, 0.6666666666666666, 0.8333333333333334, 0.004629629629629629), (0.8333333333333334, 0.6666666666666666, 0.8333333333333334, 0.004629629629629629), (0.0, 0.8333333333333334, 0.8333333333333334, 0.004629629629629629), (0.16666666666666666, 0.8333333333333334, 0.8333333333333334, 0.004629629629629629), (0.3333333333333333, 0.8333333333333334, 0.8333333333333334, 0.004629629629629629), (0.5, 0.8333333333333334, 0.8333333333333334, 0.004629629629629629), (0.6666666666666666, 0.8333333333333334, 0.8333333333333334, 0.004629629629629629), (0.8333333333333334, 0.8333333333333334, 0.8333333333333334, 0.004629629629629629)]
Next we generate a projwfc calculation using the fermi level as a guide for the energy window. The arguments are structured as (template, Emin, Emax, deltaE) respectively.
fermi = readfermi(job)
push!(job, Calculations.gencalc_projwfc(job["nscf"], fermi - 10, fermi + 1, 0.1))4-element Vector{Calculation}:
Calculation{QE}:
name = scf
exec = pw.x
run = false
data = [:k_points]
flags:
&control
calculation => scf
&system
ecutwfc => 20.0
&electrons
conv_thr => 1.0e-6
Calculation{QE}:
name = bands
exec = pw.x
run = true
data = [:k_points]
flags:
&control
verbosity => high
calculation => bands
&system
ecutwfc => 20.0
&electrons
conv_thr => 1.0e-6
Calculation{QE}:
name = nscf
exec = pw.x
run = false
data = [:k_points]
flags:
&control
verbosity => high
calculation => nscf
&system
ecutwfc => 20.0
&electrons
conv_thr => 1.0e-6
Calculation{QE}:
name = projwfc
exec = projwfc.x
run = false
data = Symbol[]
flags:
&projwfc
Emin => -3.9729
Emax => 7.0271
DeltaE => 0.1
ngauss => 0
degauss => 0.0
Next we disable the bands calculation and run the new ones.
job["bands"].run = false
submit(job)+--------------------------------------------JOB------------------------------------------+
| name: Si |
| dir: /home/runner/work/DFControl.jl/DFControl.jl/src/../docs/src/assets/Job2 |
| version: 0 |
| server: fv-az459-912, alive |
| versions: 0 |
| last submission: 2022-09-23T07:00:24 |
| state: Unknown |
+-------------------------------------------------------------------------------------------+
(scheduled, not scheduled)
scf
bands
nscf
projwfc
Plot Results
using Plots
plot(job, -10, 1)As we can see, again DFControl identifies the additional information that is now present in the job, and uses it to display in the plot.
In the demonstrated case we see that everything went according to plan, however, often things need to be changed in a trial and error way until the desired results are found.
On common occurence is that calculation flags have to be set, or changed. This can be done in two ways
job[:ecutwfc] = 40.040.0will go through all the calculations of the job and set the flag if it is allowed, i.e. the flag will not be set in the projwfc calculation since it makes no sense.
job["bands"][:nbnd] = 3030This will set a flag for one specific calculation, again checking whether the flag is valid, and the type will be converted to the correct one.
In order to quickly specify what calculations to schedule and which not, one can use
Jobs.set_flow!(job, "" => false, "scf" => true)+--------------------------------------------JOB------------------------------------------+
| name: Si |
| dir: /home/runner/work/DFControl.jl/DFControl.jl/src/../docs/src/assets/Job2 |
| version: 0 |
| server: fv-az459-912, alive |
| versions: 0 |
| last submission: 2022-09-23T07:00:24 |
| state: Unknown |
+-------------------------------------------------------------------------------------------+
(scheduled, not scheduled)
scf
bands
nscf
projwfc
As we can see, only the scf and nscf calculations are scheduled to run now, this is because for each of the pairs in the arguments of set_flow!, every calculation inside the job for which the string occurs in the name will be set to run or not depending on the Bool.