deploy: 84451d4

phonopy · Feb 2, 2024 · 9e1449c · 9e1449c
1 parent b41693e
commit 9e1449c
Show file tree

Hide file tree

Showing 139 changed files with 3,267 additions and 2,832 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 53d6e932a9e7888a92dffec296a09013
+config: 0211f950c7e0ac61f19af3a1b02b7c85
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/README.doctree b/.doctrees/README.doctree
diff --git a/.doctrees/auxiliary-tools.doctree b/.doctrees/auxiliary-tools.doctree
diff --git a/.doctrees/changelog.doctree b/.doctrees/changelog.doctree
diff --git a/.doctrees/citation.doctree b/.doctrees/citation.doctree
diff --git a/.doctrees/command-options.doctree b/.doctrees/command-options.doctree
diff --git a/.doctrees/crystal.doctree b/.doctrees/crystal.doctree
diff --git a/.doctrees/cutoff-pair.doctree b/.doctrees/cutoff-pair.doctree
diff --git a/.doctrees/direct-solution.doctree b/.doctrees/direct-solution.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/examples.doctree b/.doctrees/examples.doctree
diff --git a/.doctrees/external-tools.doctree b/.doctrees/external-tools.doctree
diff --git a/.doctrees/hdf5_howto.doctree b/.doctrees/hdf5_howto.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/input-output-files.doctree b/.doctrees/input-output-files.doctree
diff --git a/.doctrees/install.doctree b/.doctrees/install.doctree
diff --git a/.doctrees/interfaces.doctree b/.doctrees/interfaces.doctree
diff --git a/.doctrees/phono3py-api.doctree b/.doctrees/phono3py-api.doctree
diff --git a/.doctrees/phono3py-load.doctree b/.doctrees/phono3py-load.doctree
diff --git a/.doctrees/qe.doctree b/.doctrees/qe.doctree
diff --git a/.doctrees/reference.doctree b/.doctrees/reference.doctree
diff --git a/.doctrees/tips.doctree b/.doctrees/tips.doctree
diff --git a/.doctrees/turbomole.doctree b/.doctrees/turbomole.doctree
diff --git a/.doctrees/vasp.doctree b/.doctrees/vasp.doctree
diff --git a/.doctrees/wigner-solution.doctree b/.doctrees/wigner-solution.doctree
diff --git a/.doctrees/workflow.doctree b/.doctrees/workflow.doctree
diff --git a/.doctrees/workload-distribution.doctree b/.doctrees/workload-distribution.doctree
diff --git a/README.html b/README.html
@@ -1,15 +1,14 @@
 
-
 <!DOCTYPE html>
 
 
-<html lang="en" data-content_root="" >
+<html lang="en" data-content_root="./" >
 
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>How to write phono3py documentation &#8212; Phono3py v.2.9.1</title>
+    <title>How to write phono3py documentation &#8212; Phono3py v.2.9.2</title>
 
 
 
@@ -19,28 +18,28 @@
   </script>
 
   <!-- Loaded before other Sphinx assets -->
-  <link href="_static/styles/theme.css?digest=5b4479735964841361fd" rel="stylesheet" />
-<link href="_static/styles/bootstrap.css?digest=5b4479735964841361fd" rel="stylesheet" />
-<link href="_static/styles/pydata-sphinx-theme.css?digest=5b4479735964841361fd" rel="stylesheet" />
+  <link href="_static/styles/theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
+<link href="_static/styles/bootstrap.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
+<link href="_static/styles/pydata-sphinx-theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
 
 
-  <link href="_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=5b4479735964841361fd" rel="stylesheet" />
-  <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
-<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
-<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
+  <link href="_static/vendor/fontawesome/6.5.1/css/all.min.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
+  <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2" />
+<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2" />
+<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2" />
 
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
-    <link rel="stylesheet" href="_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=384b581d" />
 
   <!-- Pre-loaded scripts that we'll load fully later -->
-  <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=5b4479735964841361fd" />
-<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
-  <script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
-
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-    <script src="_static/doctools.js"></script>
-    <script src="_static/sphinx_highlight.js"></script>
-    <script src="_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script>
+  <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" />
+<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
+  <script src="_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
+
+    <script src="_static/documentation_options.js?v=157ec567"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="_static/scripts/sphinx-book-theme.js?v=efea14e4"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'README';</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -53,10 +52,9 @@
 
 
 
-  <a class="skip-link" href="#main-content">Skip to main content</a>
+  <a id="pst-skip-link" class="skip-link" href="#main-content">Skip to main content</a>
 
   <div id="pst-scroll-pixel-helper"></div>
-
 
   <button type="button" class="btn rounded-pill" id="pst-back-to-top">
     <i class="fa-solid fa-arrow-up"></i>
@@ -97,12 +95,17 @@
 </form></div>
   </div>
 
-    <nav class="bd-header navbar navbar-expand-lg bd-navbar">
-    </nav>
+    <header class="bd-header navbar navbar-expand-lg bd-navbar">
+    </header>
 
+
   <div class="bd-container">
     <div class="bd-container__inner bd-page-width">
 
+
+
+
+
       <div class="bd-sidebar-primary bd-sidebar">
 
 
@@ -126,10 +129,21 @@
 
 
 
-    <p class="title logo__title">Phono3py v.2.9.1</p>
+    <p class="title logo__title">Phono3py v.2.9.2</p>
 
 </a></div>
-        <div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
+        <div class="sidebar-primary-item">
+
+ <script>
+ document.write(`
+   <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
+    <i class="fa-solid fa-magnifying-glass"></i>
+    <span class="search-button__default-text">Search</span>
+    <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
+   </button>
+ `);
+ </script></div>
+        <div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
     <div class="bd-toc-item navbar-nav active">
         <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
@@ -317,26 +331,26 @@ <h2> Contents </h2>
 
 
 <div id="searchbox"></div>
-                <article class="bd-article" role="main">
+                <article class="bd-article">
 
   <section class="tex2jax_ignore mathjax_ignore" id="how-to-write-phono3py-documentation">
-<h1>How to write phono3py documentation<a class="headerlink" href="#how-to-write-phono3py-documentation" title="Permalink to this heading">#</a></h1>
+<h1>How to write phono3py documentation<a class="headerlink" href="#how-to-write-phono3py-documentation" title="Link to this heading">#</a></h1>
 <p>This directory contains python-sphinx documentation source.</p>
 <section id="how-to-compile">
-<h2>How to compile<a class="headerlink" href="#how-to-compile" title="Permalink to this heading">#</a></h2>
+<h2>How to compile<a class="headerlink" href="#how-to-compile" title="Link to this heading">#</a></h2>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">html</span>
 </pre></div>
 </div>
 </section>
 <section id="source-files">
-<h2>Source files<a class="headerlink" href="#source-files" title="Permalink to this heading">#</a></h2>
+<h2>Source files<a class="headerlink" href="#source-files" title="Link to this heading">#</a></h2>
 <ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">conf.py</span></code> contains the sphinx setting confiuration.</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">*.rst</span></code> are the usual sphinx documentation source and the filenames without <code class="docutils literal notranslate"><span class="pre">.rst</span></code> are the keys to link from toctree mainly in <code class="docutils literal notranslate"><span class="pre">index.rst</span></code>.</p></li>
 </ul>
 </section>
 <section id="how-to-publish">
-<h2>How to publish<a class="headerlink" href="#how-to-publish" title="Permalink to this heading">#</a></h2>
+<h2>How to publish<a class="headerlink" href="#how-to-publish" title="Link to this heading">#</a></h2>
 <p>Web page files are copied to <code class="docutils literal notranslate"><span class="pre">gh-pages</span></code> branch. At the phono3py github top directory,</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">checkout</span> <span class="n">gh</span><span class="o">-</span><span class="n">pages</span>
 <span class="n">rm</span> <span class="o">-</span><span class="n">r</span> <span class="o">.</span><span class="n">buildinfo</span> <span class="o">.</span><span class="n">doctrees</span> <span class="o">*</span>
@@ -375,6 +389,7 @@ <h2>How to publish<a class="headerlink" href="#how-to-publish" title="Permalink
 
                 <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
 
+
   <div class="sidebar-secondary-item">
   <div class="page-toc tocsection onthispage">
     <i class="fa-solid fa-list"></i> Contents
@@ -428,8 +443,8 @@ <h2>How to publish<a class="headerlink" href="#how-to-publish" title="Permalink
   </div>
 
   <!-- Scripts loaded after <body> so the DOM is not blocked -->
-  <script src="_static/scripts/bootstrap.js?digest=5b4479735964841361fd"></script>
-<script src="_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd"></script>
+  <script src="_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae"></script>
+<script src="_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae"></script>
 
   <footer class="bd-footer">
   </footer>

diff --git a/_sources/changelog.md b/_sources/changelog.md
@@ -2,6 +2,10 @@
 
 # Change Log
 
+## Feb-2-2024: Version 2.9.2
+
+- `boundary_mfp` value is stored in `kappa-*.hdf5` file when it is specified.
+
 ## Dec-26-2023: Version 2.9.1
 
 - Release to build conda-forge package.

diff --git a/_sources/command-options.md b/_sources/command-options.md
@@ -571,6 +571,8 @@ Then running with isotope calculation:
 In the result hdf5 file, currently isotope scattering strength is not written
 out, i.e., `gamma` is still imaginary part of self energy of ph-ph scattering.
 
+(boundary_mfp_option)=
+
 ### `--boundary-mfp`, `--bmfp` (`BOUNDARY_MFP`)
 
 A most simple phonon boundary scattering treatment is included. $v_g/L$ is just

diff --git a/_sources/hdf5_howto.md b/_sources/hdf5_howto.md
@@ -123,8 +123,9 @@ The array shape is (irreducible q-point, phonon band).
 (kappa_hdf5_file_gamma)=
 ### gamma
 
-Imaginary part of self energy. The physical unit is THz, where THz
-is in the ordinal frequency not the angular frequency.
+Imaginary part of self energy of phonon bubble diagram (phonon-phonon
+scattering). The physical unit is THz, where THz is in the ordinal frequency not
+the angular frequency.
 
 The array shape for all grid-points (irreducible q-points) is
 (temperature, irreducible q-point, phonon band).
@@ -262,9 +263,16 @@ P_{\mathbf{q}j} = \frac{1}{(3n_\mathrm{a})^2} \sum_{\lambda'\lambda''}
 $$
 
 This is not going to be calculated in the RTA thermal coductivity
-calculation mode by default. To calculate this, `--full_pp` option
+calculation mode by default. To calculate this, `--full-pp` option
 has to be specified (see {ref}`full_pp_option`).
 
+### boundary_mfp
+
+A value specified by {ref}`boundary_mfp_option`. The physical unit is
+micrometre.
+
+When `--boundary-mfp` option is explicitly specified, its value is stored here.
+
 ### kappa_unit_conversion
 
 This is used to convert the physical unit of lattice thermal

diff --git a/_static/basic.css b/_static/basic.css
@@ -237,6 +237,10 @@ a.headerlink {
     visibility: hidden;
 }
 
+a:visited {
+    color: #551A8B;
+}
+
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,
@@ -670,6 +674,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -738,6 +752,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,6 +1,5 @@
-var DOCUMENTATION_OPTIONS = {
-    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '2.9.1',
+const DOCUMENTATION_OPTIONS = {
+    VERSION: '2.9.2',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/_static/locales/ar/LC_MESSAGES/booktheme.po b/_static/locales/ar/LC_MESSAGES/booktheme.po
@@ -8,68 +8,68 @@ msgstr ""
 "Language: ar\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
 
+msgid "Download source file"
+msgstr "تنزيل ملف المصدر"
+
 msgid "suggest edit"
 msgstr "أقترح تحرير"
 
-msgid "Last updated on"
-msgstr "آخر تحديث في"
-
-msgid "Edit this page"
-msgstr "قم بتحرير هذه الصفحة"
-
-msgid "Launch"
-msgstr "إطلاق"
-
-msgid "Print to PDF"
-msgstr "طباعة إلى PDF"
+msgid "Toggle navigation"
+msgstr "تبديل التنقل"
 
 msgid "open issue"
 msgstr "قضية مفتوحة"
 
 msgid "Download notebook file"
 msgstr "تنزيل ملف دفتر الملاحظات"
 
-msgid "Toggle navigation"
-msgstr "تبديل التنقل"
+msgid "repository"
+msgstr "مخزن"
 
-msgid "Source repository"
-msgstr "مستودع المصدر"
+msgid "Theme by the"
+msgstr "موضوع بواسطة"
 
-msgid "By the"
-msgstr "بواسطة"
+msgid "Print to PDF"
+msgstr "طباعة إلى PDF"
 
-msgid "next page"
-msgstr "الصفحة التالية"
+msgid "Download this page"
+msgstr "قم بتنزيل هذه الصفحة"
 
-msgid "repository"
-msgstr "مخزن"
+msgid "Copyright"
+msgstr "حقوق النشر"
+
+msgid "Last updated on"
+msgstr "آخر تحديث في"
+
+msgid "Launch"
+msgstr "إطلاق"
+
+msgid "Open an issue"
+msgstr "افتح قضية"
+
+msgid "Fullscreen mode"
+msgstr "وضع ملء الشاشة"
 
 msgid "Sphinx Book Theme"
 msgstr "موضوع كتاب أبو الهول"
 
-msgid "Download source file"
-msgstr "تنزيل ملف المصدر"
-
 msgid "Contents"
 msgstr "محتويات"
 
-msgid "By"
-msgstr "بواسطة"
+msgid "Edit this page"
+msgstr "قم بتحرير هذه الصفحة"
 
-msgid "Copyright"
-msgstr "حقوق النشر"
+msgid "next page"
+msgstr "الصفحة التالية"
 
-msgid "Fullscreen mode"
-msgstr "وضع ملء الشاشة"
+msgid "Source repository"
+msgstr "مستودع المصدر"
 
-msgid "Open an issue"
-msgstr "افتح قضية"
+msgid "By"
+msgstr "بواسطة"
+
+msgid "By the"
+msgstr "بواسطة"
 
 msgid "previous page"
 msgstr "الصفحة السابقة"
-
-msgid "Download this page"
-msgstr "قم بتنزيل هذه الصفحة"
-
-msgid "Theme by the"
-msgstr "موضوع بواسطة"