Skip to content

Commit

Permalink
Added figures in the tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
ttadano committed Jul 9, 2015
1 parent 8a67747 commit 736dc2a
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 5 deletions.
Binary file added docs/img/si222.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/si_cumulative.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/si_tau.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Program *alm* estimates harmonic and anharmonic interatomic force constants (IFC
Optimization of cell parameters may also be necessary, but please note that phonon properties are relatively sensitive to the cell parameters in polar materials such as perovskites.


2. Decide to size of supercell
2. Decide the size of supercell

Next, please decide the size of a supercell. Here, one may use a conventional cell.
When the primitive cell is fairly large (:math:`a \sim 10` |Angstrom|), one may proceed with the primitive cell.
Expand All @@ -27,7 +27,7 @@ Program *alm* estimates harmonic and anharmonic interatomic force constants (IFC
Please make an input file for *alm*, say alm.in, which should contain ``&general``, ``&interaction``, ``&cutoff``, and
``&position`` entries. For details of available input variables, please refer to :ref:`here <label_inputvar_alm>`.
Once the input file is properly prepared with ``MODE = suggest``,
necessary displacement patterns may be generated by executing *alm* as follows::
necessary displacement patterns can be generated by executing *alm* as follows::
$ alm alm.in > alm.log

Expand All @@ -51,7 +51,7 @@ Program *alm* estimates harmonic and anharmonic interatomic force constants (IFC
The detail of the file format is described in :ref:`this page <label_format_DFILE>`.

.. Note::
We provide some auxiliary Python scripts to expedite the above procedure for VASP and xTAPP users.
We provide some auxiliary Python scripts to expedite the above procedure for VASP, Quantum ESPRESSO, and xTAPP users.
The script files can be found in the tools/ directory. We are planning to support other software.


Expand Down
25 changes: 23 additions & 2 deletions docs/source/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ Input files prepared for this tutorial are located in the **example/** directory
Silicon
-------

.. figure:: ../img/si222.png
:scale: 40%
:align: center

Silicon. 2x2x2 conventional supercell

In the following, (anharmonic) phonon properties of bulk silicon (Si) are calculated by a 2x2x2 conventional cell containing 64 atoms.

#. :ref:`Get displacement pattern by alm <tutorial_Si_step1>`
Expand Down Expand Up @@ -201,7 +207,8 @@ For visualizing phonon dispersion relations, we provide a Python script :red:`pl
Then, the phonon dispersion is shown by a pop-up window as follows:

.. image:: ../img/si_phband.png
:scale: 75
:scale: 60
:align: center

You can save the figure as png, eps, or other formats from this window.
You can also change the energy unit of phonon frequency from cm\ :sup:`-1` to THz or meV by the ``--unit`` option.
Expand Down Expand Up @@ -233,7 +240,8 @@ The command
will show the phonon DOS of Si by a pop-up window:

.. image:: ../img/si_phdos.png
:scale: 75
:scale: 60
:align: center

To obtain more sharp DOS, try again with a denser :math:`k` grid and a smaller ``DELTA_E`` value.

Expand Down Expand Up @@ -358,13 +366,26 @@ You can extract phonon lifetime from this file as::
gnuplot> set logscale y
gnuplot> plot "tau300K.dat" using 3:4 w p

.. figure:: ../img/si_tau.png
:scale: 40%
:align: center

Phonon lifetime of Si at 300 K

You can also estimate the cumulative thermal conductivity by
::

$ analyze_phonons.py --calc cumulative --temp 300 --length 10000:5 --direction 1 > cumulative_300K.dat
$ gnuplot
gnuplot> set logscale x
gnuplot> plot "cumulative_300K.dat" using 1:2 w lp

.. figure:: ../img/si_cumulative.png
:scale: 40%
:align: center

Cumulative thermal conductivity of Si at 300 K

The script :red:`analyze_phonons.py` can be found in the tools/ directory.
To use the script, compile the C++ code :red:`analyze_phonons.cpp` in the same directory and rename *a.out* to *analyze_phonons* (or edit the Makefile and type make).

Expand Down

0 comments on commit 736dc2a

Please sign in to comment.