Deploy docs to develop by GitHub Actions triggered by 6da3f65

issp-center-dev · Nov 16, 2023 · dd5dbc9 · dd5dbc9
1 parent 8096b75
commit dd5dbc9
Show file tree

Hide file tree

Showing 36 changed files with 215 additions and 214 deletions.
diff --git a/...ources/tutorial/simple_tutorial-1.rst.txt → ...utorial/01_transverse_field_ising.rst.txt b/...ources/tutorial/simple_tutorial-1.rst.txt → ...utorial/01_transverse_field_ising.rst.txt
diff --git a/...ources/tutorial/simple_tutorial-7.rst.txt → ...ources/tutorial/02_time_evolution.rst.txt b/...ources/tutorial/simple_tutorial-7.rst.txt → ...ources/tutorial/02_time_evolution.rst.txt
@@ -13,17 +13,17 @@ The Hamiltonian is
    \end{aligned}
 
 Please note that the model is defined using spin operators of size 1/2, not Pauli operators.
-The input and script files used in this tutorial can be found in ``sample/07_timeevolution``.
+The input and script files used in this tutorial can be found in ``sample/02_time_evolution``.
 
 Initially, we compute the ground state (refer to the ``simple.toml`` file) which serves as our starting state. Specifically, it's set as:
 
-.. literalinclude:: ../../../../sample/07_timeevolution/simple.toml
+.. literalinclude:: ../../../../sample/02_time_evolution/simple.toml
 
 Given that ``Jz = -1.0``, the ground state becomes ferromagnetic. We use the ground state as the initial state, and save the state tensor with ``tensor_save = "save_tensor"``.
 
 Next, we prepare the input file for the real-time evolution. This can be achieved by setting the ``mode`` to ``time``. Below is a sample input file (``simple_te_strong.toml``):
 
-.. literalinclude:: ../../../../sample/07_timeevolution/simple_te_strong.toml
+.. literalinclude:: ../../../../sample/02_time_evolution/simple_te_strong.toml
 
 In this case, the transverse field is set to ``hx = 2.0``, and the time-step for evolution is ``tau = 0.01``.
 Moreover, since we are utilizing the ground state as our initial condition, we load the state tensor with ``tensor_load = "save_tensor"``.

diff --git a/...ources/tutorial/simple_tutorial-8.rst.txt → ...es/tutorial/03_finite_temperature.rst.txt b/...ources/tutorial/simple_tutorial-8.rst.txt → ...es/tutorial/03_finite_temperature.rst.txt
@@ -13,9 +13,9 @@ The Hamiltonian is
    \end{aligned}
 
 Please note that the model is defined using spin operators of size 1/2, not Pauli operators.
-The input and script files used in this tutorial are located in the ``sample/08_finitetemperature`` directory. Below is a sample input file (`simple_ft_strong.toml`):
+The input and script files used in this tutorial are located in the ``sample/03_finite_temperature`` directory. Below is a sample input file (``simple_ft_strong.toml``):
 
-.. literalinclude:: ../../../../sample/08_finitetemperature/simple_ft_strong.toml
+.. literalinclude:: ../../../../sample/03_finite_temperature/simple_ft_strong.toml
 
 To perform finite temperature calculations, set the ``mode`` to ``finite``.
 Here, the transverse magnetic field is set to ``hx = 2.0`` with ``tau = 0.01`` (the inverse temperature step size is 2 times ``tau``).

diff --git a/...ources/tutorial/simple_tutorial-5.rst.txt → ...sources/tutorial/04_magnetization.rst.txt b/...ources/tutorial/simple_tutorial-5.rst.txt → ...sources/tutorial/04_magnetization.rst.txt
@@ -13,10 +13,10 @@ triangular lattice. The Hamiltonian looks like this:
    H = J \sum_{\langle i,j \rangle}\sum_{\alpha}^{x,y,z} {S}_i^{\alpha} {S}_j^{\alpha} - h \sum_i S_i^z\end{aligned}
 
 Here, :math:`\langle i, j \rangle` represents the pair of nearest neighbor sites, and :math:`h` represents the magnitude of the external magnetic field applied in the :math:`z` direction. 
-Let's calculate the ground state of this model and find :math:`\langle S_z \rangle\equiv \frac{1}{N_u}\sum_i^{N_u} \langle S_i^z \rangle`, where :math:`N_u` is the total number of sites in the unit cell, as a function of the magnetic field :math:`h`. To do this, the toml file ``basic.toml`` and the python script ``tutorial_magnetization.py`` are prepared in the ``sample/05_magnetization`` directory. 
+Let's calculate the ground state of this model and find :math:`\langle S_z \rangle\equiv \frac{1}{N_u}\sum_i^{N_u} \langle S_i^z \rangle`, where :math:`N_u` is the total number of sites in the unit cell, as a function of the magnetic field :math:`h`. To do this, the toml file ``basic.toml`` and the python script ``tutorial_magnetization.py`` are prepared in the ``sample/04_magnetization`` directory. 
 The ``basic.toml`` file contains model settings and parameters.
 
-.. literalinclude:: ../../../../sample/05_magnetization/basic.toml
+.. literalinclude:: ../../../../sample/04_magnetization/basic.toml
 
 The ``lattice`` section specifies a triangular lattice with the unit cell
 size of :math:`3\times 3`. Here, in order to make the calculation
@@ -26,7 +26,7 @@ simplicity, :math:`J=1`. Using this basic setting file,
 tutorial_magnetization.py calculates the magnetization when the magnetic
 field is swept.
 
-.. literalinclude:: ../../../../sample/05_magnetization/tutorial_magnetization.py
+.. literalinclude:: ../../../../sample/04_magnetization/tutorial_magnetization.py
 
 In this script, the magnetic field :math:`h` is changed in steps of
 :math:`0.25` from :math:`0` to :math:`5`, and the ground state energy
@@ -82,7 +82,7 @@ necessary to increase the bond dimension.
 
    Ground state energy (left figure) and magnetization (right figure) of the Heisenberg model on the triangular lattice.
 
-Next, let's perform the calculation for a model on a square lattice. Use the toml file ``basic_square.toml`` and the python script ``tutorial_magnetization_square.py`` in the ``sample/05_magnetization`` directory.
+Next, let's perform the calculation for a model on a square lattice. Use the toml file ``basic_square.toml`` and the python script ``tutorial_magnetization_square.py`` in the ``sample/04_magnetization`` directory.
 The content of ``basic_square.toml`` is the same as ``basic.toml`` except that the ``lattice`` section has been changed as follows.
 
 ::

diff --git a/...ources/tutorial/simple_tutorial-6.rst.txt → ...rial/05_hardcore_boson_triangular.rst.txt b/...ources/tutorial/simple_tutorial-6.rst.txt → ...rial/05_hardcore_boson_triangular.rst.txt
@@ -19,7 +19,7 @@ One is a superfluid order which is characterized by the offdiagonal order parame
 The other one is a solid-like order which exists at a 1/3 filling, where one of three sites is filled in a :math:`\sqrt{3}\times\sqrt{3}` ordering with wave vector :math:`\boldsymbol{Q}=(4\pi/3,0)` (see the inset of :numref:`fig_tutorial6_hardcore_boson`).
 This long-range order is characterized by the structure factor :math:`S(\boldsymbol{Q}) = \sum_{ij}^{N_\text{sites}} \langle n_i n_j \rangle \exp[-i\boldsymbol{Q}\cdot(r_i-r_j)] /N_\text{sites}`.
 
-To perform calculation for this system, the user can use toml files named ``basic.toml``, ``nn_obs.toml`` and a python script file ``run.py`` in the direction ``sample/06_hardcore_boson_triangular``. 
+To perform calculation for this system, the user can use toml files named ``basic.toml``, ``nn_obs.toml`` and a python script file ``run.py`` in the direction ``sample/05_hardcore_boson_triangular``. 
 Here, ``basic.toml`` specifies the model and its parameters.
 This file is almost the same as the triangular Heisenberg model described in the previous section and differs from it only in the section ``model`` in the last part, where the line ``type = "boson"`` specifies the hardcore boson model and ``t = 0.1``, ``V = 1`` determines the strength of the hopping and nearest-neighbor interaction.
 

diff --git a/...rces/tutorial/standard_tutorial-1.rst.txt → ...ml/_sources/tutorial/06_std_model.rst.txt b/...rces/tutorial/standard_tutorial-1.rst.txt → ...ml/_sources/tutorial/06_std_model.rst.txt
@@ -224,9 +224,9 @@ and the site Hamiltonian :math:`\mathcal{H}_i` can be written as
    \end{pmatrix}
    \end{split}
 
-When :math:`J = 0, h = 1`, for example, an input file of ``tenes_std``, ``std.toml`` (``sample/std-01_model/std.toml``), is as follows
+When :math:`J = 0, h = 1`, for example, an input file of ``tenes_std``, ``std.toml`` (``sample/06_std_model/std.toml``), is as follows
 
-.. literalinclude:: ../../../../sample/std-01_model/std.toml
+.. literalinclude:: ../../../../sample/06_std_model/std.toml
 
 We can calculate this model and obtain results as ::
    

diff --git a/manual/develop/en/html/_sources/tutorial/index.rst.txt b/manual/develop/en/html/_sources/tutorial/index.rst.txt
@@ -6,9 +6,9 @@ Tutorial
 .. toctree::
    :maxdepth: 2
 
-   simple_tutorial-1
-   simple_tutorial-7
-   simple_tutorial-8
-   simple_tutorial-5
-   simple_tutorial-6
-   standard_tutorial-1
+   01_transverse_field_ising.rst
+   02_time_evolution.rst
+   03_finite_temperature.rst
+   04_magnetization.rst
+   05_hardcore_boson_triangular.rst
+   06_std_model.rst
diff --git a/manual/develop/en/html/file_specification/index.html b/manual/develop/en/html/file_specification/index.html
@@ -14,7 +14,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="5.1. Short summary for input files of TeNeS" href="input_summary.html" />
-    <link rel="prev" title="4.6. Definition of lattices, models, and operators using the standard mode" href="../tutorial/standard_tutorial-1.html" />
+    <link rel="prev" title="4.6. Definition of lattices, models, and operators using the standard mode" href="../tutorial/06_std_model.html" />
 
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
 
@@ -118,7 +118,7 @@ <h3>Navigation</h3>
 <h3>Related Topics</h3>
 <ul>
   <li><a href="../index.html">Documentation overview</a><ul>
-      <li>Previous: <a href="../tutorial/standard_tutorial-1.html" title="previous chapter"><span class="section-number">4.6. </span>Definition of lattices, models, and operators using the standard mode</a></li>
+      <li>Previous: <a href="../tutorial/06_std_model.html" title="previous chapter"><span class="section-number">4.6. </span>Definition of lattices, models, and operators using the standard mode</a></li>
       <li>Next: <a href="input_summary.html" title="next chapter"><span class="section-number">5.1. </span>Short summary for input files of TeNeS</a></li>
   </ul></li>
 </ul>

diff --git a/manual/develop/en/html/index.html b/manual/develop/en/html/index.html
@@ -58,12 +58,12 @@ <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this head
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="tutorial/index.html">4. Tutorial</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="tutorial/simple_tutorial-1.html">4.1. Ising model with transverse magnetic field</a></li>
-<li class="toctree-l2"><a class="reference internal" href="tutorial/simple_tutorial-7.html">4.2. Real-Time Evolution of the Transverse Field Ising Model</a></li>
-<li class="toctree-l2"><a class="reference internal" href="tutorial/simple_tutorial-8.html">4.3. Finite Temperature Calculations for the Transverse Field Ising Model</a></li>
-<li class="toctree-l2"><a class="reference internal" href="tutorial/simple_tutorial-5.html">4.4. Magnetization process of the Heisenberg model on triangular and square lattices</a></li>
-<li class="toctree-l2"><a class="reference internal" href="tutorial/simple_tutorial-6.html">4.5. Phase diagram of the hardcore boson model on a trianglar lattice</a></li>
-<li class="toctree-l2"><a class="reference internal" href="tutorial/standard_tutorial-1.html">4.6. Definition of lattices, models, and operators using the standard mode</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial/01_transverse_field_ising.html">4.1. Ising model with transverse magnetic field</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial/02_time_evolution.html">4.2. Real-Time Evolution of the Transverse Field Ising Model</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial/03_finite_temperature.html">4.3. Finite Temperature Calculations for the Transverse Field Ising Model</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial/04_magnetization.html">4.4. Magnetization process of the Heisenberg model on triangular and square lattices</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial/05_hardcore_boson_triangular.html">4.5. Phase diagram of the hardcore boson model on a trianglar lattice</a></li>
+<li class="toctree-l2"><a class="reference internal" href="tutorial/06_std_model.html">4.6. Definition of lattices, models, and operators using the standard mode</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="file_specification/index.html">5. File format</a><ul>

diff --git a/manual/develop/en/html/objects.inv b/manual/develop/en/html/objects.inv
diff --git a/manual/develop/en/html/searchindex.js b/manual/develop/en/html/searchindex.js
diff --git a/...p/en/html/tutorial/simple_tutorial-1.html → ...l/tutorial/01_transverse_field_ising.html b/...p/en/html/tutorial/simple_tutorial-1.html → ...l/tutorial/01_transverse_field_ising.html
@@ -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="next" title="4.2. Real-Time Evolution of the Transverse Field Ising Model" href="simple_tutorial-7.html" />
+    <link rel="next" title="4.2. Real-Time Evolution of the Transverse Field Ising Model" href="02_time_evolution.html" />
     <link rel="prev" title="4. Tutorial" href="index.html" />
 
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
@@ -255,11 +255,11 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="../how_to_use/index.html">3. Usage</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="index.html">4. Tutorial</a><ul class="current">
 <li class="toctree-l2 current"><a class="current reference internal" href="#">4.1. Ising model with transverse magnetic field</a></li>
-<li class="toctree-l2"><a class="reference internal" href="simple_tutorial-7.html">4.2. Real-Time Evolution of the Transverse Field Ising Model</a></li>
-<li class="toctree-l2"><a class="reference internal" href="simple_tutorial-8.html">4.3. Finite Temperature Calculations for the Transverse Field Ising Model</a></li>
-<li class="toctree-l2"><a class="reference internal" href="simple_tutorial-5.html">4.4. Magnetization process of the Heisenberg model on triangular and square lattices</a></li>
-<li class="toctree-l2"><a class="reference internal" href="simple_tutorial-6.html">4.5. Phase diagram of the hardcore boson model on a trianglar lattice</a></li>
-<li class="toctree-l2"><a class="reference internal" href="standard_tutorial-1.html">4.6. Definition of lattices, models, and operators using the standard mode</a></li>
+<li class="toctree-l2"><a class="reference internal" href="02_time_evolution.html">4.2. Real-Time Evolution of the Transverse Field Ising Model</a></li>
+<li class="toctree-l2"><a class="reference internal" href="03_finite_temperature.html">4.3. Finite Temperature Calculations for the Transverse Field Ising Model</a></li>
+<li class="toctree-l2"><a class="reference internal" href="04_magnetization.html">4.4. Magnetization process of the Heisenberg model on triangular and square lattices</a></li>
+<li class="toctree-l2"><a class="reference internal" href="05_hardcore_boson_triangular.html">4.5. Phase diagram of the hardcore boson model on a trianglar lattice</a></li>
+<li class="toctree-l2"><a class="reference internal" href="06_std_model.html">4.6. Definition of lattices, models, and operators using the standard mode</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../file_specification/index.html">5. File format</a></li>
@@ -275,7 +275,7 @@ <h3>Related Topics</h3>
   <li><a href="../index.html">Documentation overview</a><ul>
   <li><a href="index.html"><span class="section-number">4. </span>Tutorial</a><ul>
       <li>Previous: <a href="index.html" title="previous chapter"><span class="section-number">4. </span>Tutorial</a></li>
-      <li>Next: <a href="simple_tutorial-7.html" title="next chapter"><span class="section-number">4.2. </span>Real-Time Evolution of the Transverse Field Ising Model</a></li>
+      <li>Next: <a href="02_time_evolution.html" title="next chapter"><span class="section-number">4.2. </span>Real-Time Evolution of the Transverse Field Ising Model</a></li>
   </ul></li>
   </ul></li>
 </ul>
@@ -310,7 +310,7 @@ <h3 id="searchlabel">Quick search</h3>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
 
       |
-      <a href="../_sources/tutorial/simple_tutorial-1.rst.txt"
+      <a href="../_sources/tutorial/01_transverse_field_ising.rst.txt"
           rel="nofollow">Page source</a>
     </div>
 

diff --git a/...p/en/html/tutorial/simple_tutorial-7.html → ...p/en/html/tutorial/02_time_evolution.html b/...p/en/html/tutorial/simple_tutorial-7.html → ...p/en/html/tutorial/02_time_evolution.html
@@ -14,8 +14,8 @@
     <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="next" title="4.3. Finite Temperature Calculations for the Transverse Field Ising Model" href="simple_tutorial-8.html" />
-    <link rel="prev" title="4.1. Ising model with transverse magnetic field" href="simple_tutorial-1.html" />
+    <link rel="next" title="4.3. Finite Temperature Calculations for the Transverse Field Ising Model" href="03_finite_temperature.html" />
+    <link rel="prev" title="4.1. Ising model with transverse magnetic field" href="01_transverse_field_ising.html" />
 
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
 
@@ -41,7 +41,7 @@ <h1><span class="section-number">4.2. </span>Real-Time Evolution of the Transver
 H = J^z \sum_{\langle i,j \rangle} {S}_i^{z} {S}_j^{z} - h^x \sum_i S_i^x.
 \end{aligned}\]</div>
 <p>Please note that the model is defined using spin operators of size 1/2, not Pauli operators.
-The input and script files used in this tutorial can be found in <code class="docutils literal notranslate"><span class="pre">sample/07_timeevolution</span></code>.</p>
+The input and script files used in this tutorial can be found in <code class="docutils literal notranslate"><span class="pre">sample/02_time_evolution</span></code>.</p>
 <p>Initially, we compute the ground state (refer to the <code class="docutils literal notranslate"><span class="pre">simple.toml</span></code> file) which serves as our starting state. Specifically, it’s set as:</p>
 <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[parameter]
 [parameter.general]
@@ -203,12 +203,12 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="../install.html">2. Install</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../how_to_use/index.html">3. Usage</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="index.html">4. Tutorial</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="simple_tutorial-1.html">4.1. Ising model with transverse magnetic field</a></li>
+<li class="toctree-l2"><a class="reference internal" href="01_transverse_field_ising.html">4.1. Ising model with transverse magnetic field</a></li>
 <li class="toctree-l2 current"><a class="current reference internal" href="#">4.2. Real-Time Evolution of the Transverse Field Ising Model</a></li>
-<li class="toctree-l2"><a class="reference internal" href="simple_tutorial-8.html">4.3. Finite Temperature Calculations for the Transverse Field Ising Model</a></li>
-<li class="toctree-l2"><a class="reference internal" href="simple_tutorial-5.html">4.4. Magnetization process of the Heisenberg model on triangular and square lattices</a></li>
-<li class="toctree-l2"><a class="reference internal" href="simple_tutorial-6.html">4.5. Phase diagram of the hardcore boson model on a trianglar lattice</a></li>
-<li class="toctree-l2"><a class="reference internal" href="standard_tutorial-1.html">4.6. Definition of lattices, models, and operators using the standard mode</a></li>
+<li class="toctree-l2"><a class="reference internal" href="03_finite_temperature.html">4.3. Finite Temperature Calculations for the Transverse Field Ising Model</a></li>
+<li class="toctree-l2"><a class="reference internal" href="04_magnetization.html">4.4. Magnetization process of the Heisenberg model on triangular and square lattices</a></li>
+<li class="toctree-l2"><a class="reference internal" href="05_hardcore_boson_triangular.html">4.5. Phase diagram of the hardcore boson model on a trianglar lattice</a></li>
+<li class="toctree-l2"><a class="reference internal" href="06_std_model.html">4.6. Definition of lattices, models, and operators using the standard mode</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../file_specification/index.html">5. File format</a></li>
@@ -223,8 +223,8 @@ <h3>Related Topics</h3>
 <ul>
   <li><a href="../index.html">Documentation overview</a><ul>
   <li><a href="index.html"><span class="section-number">4. </span>Tutorial</a><ul>
-      <li>Previous: <a href="simple_tutorial-1.html" title="previous chapter"><span class="section-number">4.1. </span>Ising model with transverse magnetic field</a></li>
-      <li>Next: <a href="simple_tutorial-8.html" title="next chapter"><span class="section-number">4.3. </span>Finite Temperature Calculations for the Transverse Field Ising Model</a></li>
+      <li>Previous: <a href="01_transverse_field_ising.html" title="previous chapter"><span class="section-number">4.1. </span>Ising model with transverse magnetic field</a></li>
+      <li>Next: <a href="03_finite_temperature.html" title="next chapter"><span class="section-number">4.3. </span>Finite Temperature Calculations for the Transverse Field Ising Model</a></li>
   </ul></li>
   </ul></li>
 </ul>
@@ -259,7 +259,7 @@ <h3 id="searchlabel">Quick search</h3>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
 
       |
-      <a href="../_sources/tutorial/simple_tutorial-7.rst.txt"
+      <a href="../_sources/tutorial/02_time_evolution.rst.txt"
           rel="nofollow">Page source</a>
     </div>