File: phonopy-load.md

package info (click to toggle)
phonopy 2.47.1-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 29,380 kB
  • sloc: python: 43,690; xml: 12,080; ansic: 3,227; cpp: 525; sh: 213; makefile: 20
file content (73 lines) | stat: -rw-r--r-- 2,601 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
(phonopy_load_command)=

# phonopy-load command

The primary purpose of introducing this command is to ensure consistent usage
across various force calculators (VASP, QE, ...). Additionally, more optimized
default settings are provided (see {ref}`phonopy_load_command_differences`).

## Example

In the NaCl example for the VASP calculator,

```bash
% phonopy -d --dim 2 2 2 --pa auto -c POSCAR-unitcell
% phonopy --sp -f vasprun.xml-00{1,2}
```

In the NaCl-qe example for the QE calculator,

```bash
% phonopy --qe -d --dim 2 2 2 --pa auto -c NaCl.in
% phonopy --sp -f NaCl-00{1,2}.out
```

The first and second commands create `phonopy_disp.yaml` and
`phonopy_params.yaml`, respectively.

Once having the `phonopy_xxx.yaml` file, it is unnecessary to specify the
calculator name (e.g. `--qe` option). The phonon calculation as the post-process
works:

```bash
% phonopy-load --band auto -p phonopy_params.yaml
```

`phonopy-load` can read files with the following extensions `xz`, `lzma`, `gz`,
and `bz2`. Therefore when the file size of `phonopy_params.yaml` is large, it is
recommended to compress it.

```bash
% xz phonopy_params.yaml
% phonopy-load --band auto -p phonopy_params.yaml.xz
```

(phonopy_load_command_differences)=
## List of differences from phonopy command

The following default behaviours are different from that of those of `phonopy`
command:

- `phonopy_xxx.yaml` type file ({ref}`phonopy_yaml_format`) is always necessary
   in either of two ways:

  1. `phonopy_xxx.yaml` type file is given as the first argument of the command.
  2. `phonopy_disp.yaml` or `phonopy.yaml` is put in the current directory. The
     searching preference order is `phonopy_disp.yaml` > `phonopy.yaml`.

- `-c` option (read crystal structure) does not exist.

- Use of command options is recommended, but a phonopy configuration file
  ({ref}`configuration_file`) can be read through `--config` option.

- If parameters for non-analytical term correction (NAC) are found, NAC is
  automatically enabled. This can be disabled by `--nonac` option.

- When force constants are calculated from displacements and forces dataset,
  force constants are automatically symmetrized. From phonopy v2.30.0, `symfc`
  is used for the symmetrization. From phonopy v2.41.0, symfc-projector is used
  to symmetrize force constants calculated by finite difference approach. The
  old behavior of the symmetrization can be performed by `--fc-calculator
  traditional` option. `--no-sym-fc` option can be used to calculate force
  constants in the traditional force constants calculator without
  symmetrization.