Writing to external formats

Phonon website visualisation

The phonon visualisation website is a useful tool for the interpretation of phonon band structures with related eigenvectors. A QpointPhononModes object can be combined with a corresponding set of \(\mathbf{q}\)-point labels to write an appropriate JSON file, which is importable as a “custom file”.

write_phonon_website_json(modes, output_file='phonons.json', name='Euphonic export', x_tick_labels=None)

Dump to .json for use with phonon website visualiser

Use with javascript application at https://henriquemiranda.github.io/phononwebsite

Parameters:

• modes (QpointPhononModes) – Phonon frequencies and eigenvectors along q-point path

• output_file (str | Path) – Path to output file

• name (str) – Set “name” metadata, to be used as figure title

• x_tick_labels (list[tuple[int, str]] | None) – index and label for high symmetry labels (if known)

Return type:

None