Deploy docs to develop by GitHub Actions triggered by 69d21f6

issp-center-dev · Sep 10, 2024 · 65e50c6 · 65e50c6
1 parent d1d07dd
commit 65e50c6
Show file tree

Hide file tree

Showing 34 changed files with 167 additions and 162 deletions.
diff --git a/manual/develop/en/cif2x-usersguide.pdf b/manual/develop/en/cif2x-usersguide.pdf
diff --git a/manual/develop/en/html/_sources/cif2x/about/index.rst.txt b/manual/develop/en/html/_sources/cif2x/about/index.rst.txt
@@ -49,6 +49,9 @@ This software was developed by the following contributors.
 Release history
 ----------------------------------------------------------------
 
+  ver.1.1.0
+    Released on 2024/09/14
+
   ver.1.0.1
     Released on 2024/03/31
 

diff --git a/manual/develop/en/html/cif2x/about/index.html b/manual/develop/en/html/cif2x/about/index.html
@@ -78,6 +78,8 @@ <h2><span class="section-number">1.3. </span>Contributors<a class="headerlink" h
 <h2><span class="section-number">1.4. </span>Release history<a class="headerlink" href="#release-history" title="Link to this heading">¶</a></h2>
 <blockquote>
 <div><dl class="simple">
+<dt>ver.1.1.0</dt><dd><p>Released on 2024/09/14</p>
+</dd>
 <dt>ver.1.0.1</dt><dd><p>Released on 2024/03/31</p>
 </dd>
 <dt>ver.1.0.0</dt><dd><p>Released on 2024/03/19</p>
@@ -127,7 +129,7 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="../command/index.html">4. Command reference</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../filespec/index.html">5. File format</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../appendix/index.html">6. Extension guide</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../getcif/index.html">7. A tool to retrieve crystallographic data from databases (getcif)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../getcif/index.html">A tool to retrieve crystallographic data from databases (getcif)</a></li>
 </ul>
 </li>
 </ul>

diff --git a/manual/develop/en/html/cif2x/appendix/index.html b/manual/develop/en/html/cif2x/appendix/index.html
@@ -13,7 +13,7 @@
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
-    <link rel="next" title="7. A tool to retrieve crystallographic data from databases (getcif)" href="../../getcif/index.html" />
+    <link rel="next" title="A tool to retrieve crystallographic data from databases (getcif)" href="../../getcif/index.html" />
     <link rel="prev" title="5. File format" href="../filespec/index.html" />
 
   <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
@@ -94,7 +94,7 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="../command/index.html">4. Command reference</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../filespec/index.html">5. File format</a></li>
 <li class="toctree-l2 current"><a class="current reference internal" href="#">6. Extension guide</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../getcif/index.html">7. A tool to retrieve crystallographic data from databases (getcif)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../getcif/index.html">A tool to retrieve crystallographic data from databases (getcif)</a></li>
 </ul>
 </li>
 </ul>
@@ -105,7 +105,7 @@ <h3>Related Topics</h3>
   <li><a href="../../index.html">Documentation overview</a><ul>
   <li><a href="../index.html">Input file generator for first-principles calculations (cif2x)</a><ul>
       <li>Previous: <a href="../filespec/index.html" title="previous chapter"><span class="section-number">5. </span>File format</a></li>
-      <li>Next: <a href="../../getcif/index.html" title="next chapter"><span class="section-number">7. </span>A tool to retrieve crystallographic data from databases (getcif)</a></li>
+      <li>Next: <a href="../../getcif/index.html" title="next chapter">A tool to retrieve crystallographic data from databases (getcif)</a></li>
   </ul></li>
   </ul></li>
 </ul>

diff --git a/manual/develop/en/html/cif2x/basic-usage.html b/manual/develop/en/html/cif2x/basic-usage.html
@@ -179,7 +179,7 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="command/index.html">4. Command reference</a></li>
 <li class="toctree-l2"><a class="reference internal" href="filespec/index.html">5. File format</a></li>
 <li class="toctree-l2"><a class="reference internal" href="appendix/index.html">6. Extension guide</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../getcif/index.html">7. A tool to retrieve crystallographic data from databases (getcif)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getcif/index.html">A tool to retrieve crystallographic data from databases (getcif)</a></li>
 </ul>
 </li>
 </ul>

diff --git a/manual/develop/en/html/cif2x/command/index.html b/manual/develop/en/html/cif2x/command/index.html
@@ -110,7 +110,7 @@ <h3>Navigation</h3>
 <li class="toctree-l2 current"><a class="current reference internal" href="#">4. Command reference</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../filespec/index.html">5. File format</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../appendix/index.html">6. Extension guide</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../getcif/index.html">7. A tool to retrieve crystallographic data from databases (getcif)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../getcif/index.html">A tool to retrieve crystallographic data from databases (getcif)</a></li>
 </ul>
 </li>
 </ul>

diff --git a/manual/develop/en/html/cif2x/filespec/index.html b/manual/develop/en/html/cif2x/filespec/index.html
@@ -338,7 +338,7 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="../command/index.html">4. Command reference</a></li>
 <li class="toctree-l2 current"><a class="current reference internal" href="#">5. File format</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../appendix/index.html">6. Extension guide</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../getcif/index.html">7. A tool to retrieve crystallographic data from databases (getcif)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../getcif/index.html">A tool to retrieve crystallographic data from databases (getcif)</a></li>
 </ul>
 </li>
 </ul>

diff --git a/manual/develop/en/html/cif2x/index.html b/manual/develop/en/html/cif2x/index.html
@@ -69,12 +69,12 @@ <h1>Input file generator for first-principles calculations (cif2x)<a class="head
 <li class="toctree-l2"><a class="reference internal" href="appendix/index.html#adding-modes-of-quantum-espresso">6.1. Adding modes of Quantum ESPRESSO</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="../getcif/index.html">7. A tool to retrieve crystallographic data from databases (getcif)</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../getcif/about/index.html">7.1. Introduction</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../getcif/tutorial/index.html">7.2. Tutorial</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../getcif/command/index.html">7.3. Command reference</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../getcif/filespec/index.html">7.4. File format</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../getcif/appendix/index.html">7.5. Parameter List</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../getcif/index.html">A tool to retrieve crystallographic data from databases (getcif)</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../getcif/about/index.html">1. Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getcif/tutorial/index.html">2. Tutorial</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getcif/command/index.html">3. Command reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getcif/filespec/index.html">4. File format</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getcif/appendix/index.html">5. Parameter List</a></li>
 </ul>
 </li>
 </ul>
@@ -107,7 +107,7 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="command/index.html">4. Command reference</a></li>
 <li class="toctree-l2"><a class="reference internal" href="filespec/index.html">5. File format</a></li>
 <li class="toctree-l2"><a class="reference internal" href="appendix/index.html">6. Extension guide</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../getcif/index.html">7. A tool to retrieve crystallographic data from databases (getcif)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../getcif/index.html">A tool to retrieve crystallographic data from databases (getcif)</a></li>
 </ul>
 </li>
 </ul>

diff --git a/manual/develop/en/html/cif2x/tutorial/index.html b/manual/develop/en/html/cif2x/tutorial/index.html
@@ -160,7 +160,7 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="../command/index.html">4. Command reference</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../filespec/index.html">5. File format</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../appendix/index.html">6. Extension guide</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../getcif/index.html">7. A tool to retrieve crystallographic data from databases (getcif)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../getcif/index.html">A tool to retrieve crystallographic data from databases (getcif)</a></li>
 </ul>
 </li>
 </ul>

diff --git a/manual/develop/en/html/getcif/about/index.html b/manual/develop/en/html/getcif/about/index.html
@@ -5,16 +5,16 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>7.1. Introduction &#8212; cif2x Users Guide 1.1.0 documentation</title>
+    <title>1. Introduction &#8212; cif2x Users Guide 1.1.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../../_static/alabaster.css?v=94bc0932" />
     <script src="../../_static/documentation_options.js?v=fc837d61"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
-    <link rel="next" title="7.2. Tutorial" href="../tutorial/index.html" />
-    <link rel="prev" title="7. A tool to retrieve crystallographic data from databases (getcif)" href="../index.html" />
+    <link rel="next" title="2. Tutorial" href="../tutorial/index.html" />
+    <link rel="prev" title="A tool to retrieve crystallographic data from databases (getcif)" href="../index.html" />
 
   <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
 
@@ -33,7 +33,7 @@
           <div class="body" role="main">
 
   <section id="introduction">
-<h1><span class="section-number">7.1. </span>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">¶</a></h1>
+<h1><span class="section-number">1. </span>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">¶</a></h1>
 <p><code class="docutils literal notranslate"><span class="pre">getcif</span></code> is a tool to retrieve crystallographic information and other properties of materials from databases. The latest version of getcif provides access to Materials Project database. Users can search database and obtain information by specifying symmetry, composition, or physical properties of materials.</p>
 </section>
 
@@ -63,7 +63,7 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="../../cif2x/command/index.html">4. Command reference</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../cif2x/filespec/index.html">5. File format</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../cif2x/appendix/index.html">6. Extension guide</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../index.html">7. A tool to retrieve crystallographic data from databases (getcif)</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../index.html">A tool to retrieve crystallographic data from databases (getcif)</a></li>
 </ul>
 </li>
 </ul>
@@ -73,9 +73,9 @@ <h3>Related Topics</h3>
 <ul>
   <li><a href="../../index.html">Documentation overview</a><ul>
   <li><a href="../../cif2x/index.html">Input file generator for first-principles calculations (cif2x)</a><ul>
-  <li><a href="../index.html"><span class="section-number">7. </span>A tool to retrieve crystallographic data from databases (getcif)</a><ul>
-      <li>Previous: <a href="../index.html" title="previous chapter"><span class="section-number">7. </span>A tool to retrieve crystallographic data from databases (getcif)</a></li>
-      <li>Next: <a href="../tutorial/index.html" title="next chapter"><span class="section-number">7.2. </span>Tutorial</a></li>
+  <li><a href="../index.html">A tool to retrieve crystallographic data from databases (getcif)</a><ul>
+      <li>Previous: <a href="../index.html" title="previous chapter">A tool to retrieve crystallographic data from databases (getcif)</a></li>
+      <li>Next: <a href="../tutorial/index.html" title="next chapter"><span class="section-number">2. </span>Tutorial</a></li>
   </ul></li>
   </ul></li>
   </ul></li>

diff --git a/manual/develop/en/html/getcif/appendix/index.html b/manual/develop/en/html/getcif/appendix/index.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>7.5. Parameter List &#8212; cif2x Users Guide 1.1.0 documentation</title>
+    <title>5. Parameter List &#8212; cif2x Users Guide 1.1.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../../_static/alabaster.css?v=94bc0932" />
     <script src="../../_static/documentation_options.js?v=fc837d61"></script>
@@ -14,7 +14,7 @@
     <script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
-    <link rel="prev" title="7.4. File format" href="../filespec/index.html" />
+    <link rel="prev" title="4. File format" href="../filespec/index.html" />
 
   <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
 
@@ -33,9 +33,9 @@
           <div class="body" role="main">
 
   <section id="parameter-list">
-<h1><span class="section-number">7.5. </span>Parameter List<a class="headerlink" href="#parameter-list" title="Link to this heading">¶</a></h1>
+<h1><span class="section-number">5. </span>Parameter List<a class="headerlink" href="#parameter-list" title="Link to this heading">¶</a></h1>
 <section id="search-conditions-properties">
-<h2>Search conditions (properties)<a class="headerlink" href="#search-conditions-properties" title="Link to this heading">¶</a></h2>
+<h2><span class="section-number">5.1. </span>Search conditions (properties)<a class="headerlink" href="#search-conditions-properties" title="Link to this heading">¶</a></h2>
 <p>Table <a class="reference internal" href="#getcif-cond-table"><span class="std std-ref">Search criteria</span></a> summarizes condition terms available in the properties section.</p>
 <p><code class="docutils literal notranslate"><span class="pre">getcif</span></code> uses the <code class="docutils literal notranslate"><span class="pre">mp-api</span></code> library provided by Materials Project as a client for accessing the database via Materials Project API. The condition terms correspond to the parameters for the <code class="docutils literal notranslate"><span class="pre">materials.summary.search</span></code> method of MPRester class in <code class="docutils literal notranslate"><span class="pre">mp-api</span></code>. (The content of the table is taken and reformatted from the comments of the source file in <code class="docutils literal notranslate"><span class="pre">mpi-api</span></code>.)</p>
 <p>The types of the parameter values denote as follows:</p>
@@ -89,7 +89,7 @@ <h2>Search conditions (properties)<a class="headerlink" href="#search-conditions
 </dl>
 </div></blockquote>
 <span id="getcif-cond-table"></span><table class="docutils align-default" id="id1">
-<caption><span class="caption-number">Table 7.1 </span><span class="caption-text">Search criteria</span><a class="headerlink" href="#id1" title="Link to this table">¶</a></caption>
+<caption><span class="caption-number">Table 5.1 </span><span class="caption-text">Search criteria</span><a class="headerlink" href="#id1" title="Link to this table">¶</a></caption>
 <colgroup>
 <col style="width: 27.3%" />
 <col style="width: 18.2%" />
@@ -306,7 +306,7 @@ <h2>Search conditions (properties)<a class="headerlink" href="#search-conditions
 </table>
 </section>
 <section id="data-to-retrive-fields">
-<h2>Data to retrive (fields)<a class="headerlink" href="#data-to-retrive-fields" title="Link to this heading">¶</a></h2>
+<h2><span class="section-number">5.2. </span>Data to retrive (fields)<a class="headerlink" href="#data-to-retrive-fields" title="Link to this heading">¶</a></h2>
 <p>The items available for the <code class="docutils literal notranslate"><span class="pre">fields</span></code> section for retrieving from the database are listed below.</p>
 <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>band_gap
 bandstructure
@@ -408,7 +408,7 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="../../cif2x/command/index.html">4. Command reference</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../cif2x/filespec/index.html">5. File format</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../cif2x/appendix/index.html">6. Extension guide</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../index.html">7. A tool to retrieve crystallographic data from databases (getcif)</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../index.html">A tool to retrieve crystallographic data from databases (getcif)</a></li>
 </ul>
 </li>
 </ul>
@@ -418,8 +418,8 @@ <h3>Related Topics</h3>
 <ul>
   <li><a href="../../index.html">Documentation overview</a><ul>
   <li><a href="../../cif2x/index.html">Input file generator for first-principles calculations (cif2x)</a><ul>
-  <li><a href="../index.html"><span class="section-number">7. </span>A tool to retrieve crystallographic data from databases (getcif)</a><ul>
-      <li>Previous: <a href="../filespec/index.html" title="previous chapter"><span class="section-number">7.4. </span>File format</a></li>
+  <li><a href="../index.html">A tool to retrieve crystallographic data from databases (getcif)</a><ul>
+      <li>Previous: <a href="../filespec/index.html" title="previous chapter"><span class="section-number">4. </span>File format</a></li>
   </ul></li>
   </ul></li>
   </ul></li>