scnc
/
phonopy
mirror of https://github.com/phonopy/phonopy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Minor update of document

This commit is contained in:
Atsushi Togo 2015-08-12 15:03:58 +09:00
parent bf8178b4fb
commit 70e0a08ece
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/phonopy/command-options.rst
View File

@ -386,20 +386,31 @@ This tag can be used together with the ``--cell`` (``-c``),
``--abinit``, ``--pwscf``, ``--elk``, ``--wien2k``, or
``--primitive_axis`` option.
Output file control
---------------------
Input/Output file control
-------------------------
.. _hdf5_option:
``--hdf5``
~~~~~~~~~~~
The following output files are written in hdf5 format instead of their
original formats (in parenthesis).
The following input/output files are read/written in hdf5 format
instead of their original formats (in parenthesis).
* ``force_constants.hdf5`` (``FORCE_CONSTANTS``)
* ``mesh.hdf5`` (``mesh.yaml``)
``force_constants.hdf5``
^^^^^^^^^^^^^^^^^^^^^^^^^
With ``--hdf5`` option and ``FORCE_CONSTANTS = WRITE``
(``--writefc``), ``force_constants.hdf5`` is written.
With ``--hdf5`` option and ``FORCE_CONSTANTS = READ`` (``--readfc``),
``force_constants.hdf5`` is read.
``mesh.hdf5``
^^^^^^^^^^^^^^
In the mesh sampling calculations (see :ref:`mesh_sampling_tags`),
calculation results are written into ``mesh.hdf5`` but not into
``mesh.yaml``. Using this option may reduce the data output size and