From 70e0a08ece47ff10ae102305f69bd1e636f867fc Mon Sep 17 00:00:00 2001 From: Atsushi Togo Date: Wed, 12 Aug 2015 15:03:58 +0900 Subject: [PATCH] Minor update of document --- doc/phonopy/command-options.rst | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/doc/phonopy/command-options.rst b/doc/phonopy/command-options.rst index 16deb750..2f03636a 100644 --- a/doc/phonopy/command-options.rst +++ b/doc/phonopy/command-options.rst @@ -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