Update manuals

mitsuaki1987 · Apr 23, 2016 · ca0e8b7 · ca0e8b7
1 parent 7f89ca4
commit ca0e8b7
Show file tree

Hide file tree

Showing 33 changed files with 52,531 additions and 130,341 deletions.
diff --git a/doc/figs/background.eps b/doc/figs/background.eps
diff --git a/doc/figs/background.odg b/doc/figs/background.odg
diff --git a/doc/figs/background.svg b/doc/figs/background.svg
diff --git a/doc/figs/band.eps b/doc/figs/band.eps
diff --git a/doc/figs/band.odg b/doc/figs/band.odg
diff --git a/doc/figs/band.svg b/doc/figs/band.svg
diff --git a/doc/figs/brillouinzone.eps b/doc/figs/brillouinzone.eps
diff --git a/doc/figs/brillouinzone.odg b/doc/figs/brillouinzone.odg
diff --git a/doc/figs/brillouinzone.svg b/doc/figs/brillouinzone.svg
diff --git a/doc/figs/colorbar.eps b/doc/figs/colorbar.eps
diff --git a/doc/figs/colorbar.odg b/doc/figs/colorbar.odg
diff --git a/doc/figs/colorbar.svg b/doc/figs/colorbar.svg
diff --git a/doc/figs/colorscale.eps b/doc/figs/colorscale.eps
diff --git a/doc/figs/colorscale.odg b/doc/figs/colorscale.odg
diff --git a/doc/figs/colorscale.svg b/doc/figs/colorscale.svg
diff --git a/doc/figs/iro2.eps b/doc/figs/iro2.eps
diff --git a/doc/figs/iro2.odg b/doc/figs/iro2.odg
diff --git a/doc/figs/iro2.svg b/doc/figs/iro2.svg
diff --git a/doc/figs/nodeline.eps b/doc/figs/nodeline.eps
diff --git a/doc/figs/nodeline.odg b/doc/figs/nodeline.odg
diff --git a/doc/figs/nodeline.svg b/doc/figs/nodeline.svg
diff --git a/doc/figs/setview.svg b/doc/figs/setview.svg
diff --git a/doc/figs/shift.eps b/doc/figs/shift.eps
diff --git a/doc/figs/shift.odg b/doc/figs/shift.odg
diff --git a/doc/figs/shift.svg b/doc/figs/shift.svg
diff --git a/doc/figs/start.eps b/doc/figs/start.eps
diff --git a/doc/figs/start.odg b/doc/figs/start.odg
diff --git a/doc/figs/start.svg b/doc/figs/start.svg
diff --git a/doc/figs/stereogram.eps b/doc/figs/stereogram.eps
diff --git a/doc/figs/stereogram.odg b/doc/figs/stereogram.odg
diff --git a/doc/figs/stereogram.svg b/doc/figs/stereogram.svg
diff --git a/doc/manual_right_en.html b/doc/manual_right_en.html
@@ -18,7 +18,7 @@
   <body bgcolor="CCFFCC">
 
     <center><h1>Manual for FermiSurfer</h1></center>
-    <center><h2>Version 1.6</h2></center>
+    <center><h2>Version 1.7</h2></center>
     <center><h2>Mitsuaki Kawamura</h2></center>
 
     <hr>
@@ -206,10 +206,9 @@ <h1><a name="introduction">1, Introduction</a></h1>
       an input file for XCrysDen (the bxsf format)
       by using the utility program <code>bxsf2frmsf</code>.
     </p>
-    <p>使い方は次のとおりです.<code>examples/</code>ディレクトリにある<code>pb.bxsf</code>
-      ファイルを例として使います.</p>
+    <p>The usage is as follow (we use <code>examples/pb.bxsf</code> as an example.):</p>
 
-    <h3>5.2.1, For Linuxの場合</h2>
+    <h3>5.2.1, For Linux</h2>
 
     <p>You can launch generated executable as follows:</p>
     <pre><code>
@@ -285,7 +284,7 @@ <h3>5.2.2, For Windows</h3>
   FILE* fo;
   int ibnd, ik1, ik2, ik3;
 
-  fo = fopen(“sample.frmsf”, “w”);
+  fo = fopen("sample.frmsf", "w");
   ierr = fprintf(fo, &quot;%d %d %d\n&quot;, nk1, nk2, nk3);
   ierr = fprintf(fo, &quot;%d\n&quot;, iswitch);
   ierr = fprintf(fo, &quot;%d\n&quot;, nbnd);
@@ -422,17 +421,38 @@ <h3>5.2.2, For Windows</h3>
       Fig. 3: The Fermi energy is set from 0 Ry to 0.1 Ry 
       with <code>Shift Fermi energy</code> menu</p>
 
-    <hr><h2 id="background-color">6.6, Background color</h2>
+   <hr><h2 id="setview">6.6, Set view</h2>
+
+    <p>Changing the view point.</p>
+    <dl>
+      <dt>Scale</dt>
+      <dd><p>Change the size of the figure.</p>
+      </dd>
+      <dt>Position</dt>
+      <dd><p>Change the xy position of the figure.</p>
+      </dd>
+      <dt>Rotation</dt>
+      <dd><p>Change angles at x-, y-, z- axis.
+          Rotaions are performed as z-y-x axis.</p>
+      </dd>
+    </dl>
+    <p>In each menu, first the current value is printed.
+      then a prompt to input the new value appears (Fig. 4).</p>
+
+    <p><img src="figs/setview.jpg" align="middle" width="800" alt="" />
+      Fig. 4: Modify the view point by using <code>Set view</code> menu</p>
+
+    <hr><h2 id="background-color">6.7, Background color</h2>
 
     <p>The background color is toggled between black and white; 
       the edge of the Brillouin Zone is also toggled between white and black 
-      (Fig. 4).</p>
+      (Fig. 5).</p>
     <p><img src="figs/background.jpg" align="middle" width="800" alt="" />
-      Fig. 4: The background color is toggled with <code>Background color</code> menu.</p>
+      Fig. 5: The background color is toggled with <code>Background color</code> menu.</p>
 
-    <hr><h2 id="color-scale-mode">6.7, Color scale mode</h2>
+    <hr><h2 id="color-scale-mode">6.8, Color scale mode</h2>
 
-    <p>It turns color pattern on Fermi surfaces (Fig. 5).</p>
+    <p>It turns color pattern on Fermi surfaces (Fig. 6).</p>
     <dl>
       <p>Auto(default) : It makes blue as the minimum on Fermi surfaces 
         and red as the maximum on them.</p>
@@ -447,55 +467,55 @@ <h3>5.2.2, For Windows</h3>
           $\rightarrow$ cyan $\rightarrow$ blue $\rightarrow$ magenta $\rightarrow$ red.</p>
     </dl>
     <p><img src="figs/colorscale.jpg" align="middle" width="800" alt="" />
-      Fig. 5: <code>Color scale mode</code> menu.</p>
+      Fig. 6: <code>Color scale mode</code> menu.</p>
 
-    <hr><h2 id="brillouin-zone">6.8, Brillouin zone</h2>
+    <hr><h2 id="brillouin-zone">6.9, Brillouin zone</h2>
 
-    <p>You choose Brillouin-zone type as follows (Fig. 6):</p>
+    <p>You choose Brillouin-zone type as follows (Fig. 7):</p>
     <dl>
       <p>First Brillouin Zone : The region surrounded by Bragg's planes 
         the nearest to ${\rm \Gamma}$ point.</p>
       <p>Primitive Brillouin Zone : A hexahedron whose corner is the reciprocal lattice point.</p>
     </dl>
     <p><img src="figs/brillouinzone.jpg" align="middle" width="800" alt="" />
-      Fig. 6: You can change the type of the Brillouin zone 
+      Fig. 7: You can change the type of the Brillouin zone 
       with <code>Brillouin zone</code> menu.</p>
 
-    <hr><h2 id="node-line">6.9, Node line</h2>
+    <hr><h2 id="node-line">6.10, Node line</h2>
 
     <p>The line on which the matrix element becomes 0 (we call it node line) 
-      becomes enable/disable (Fig. 7).</p>
+      becomes enable/disable (Fig. 8).</p>
     <p><img src="figs/nodeline.jpg" align="middle" width="800" alt="" /> 
-      Fig. 7: Toggling the node line with <code>Node line</code> menu.</p>
+      Fig. 8: Toggling the node line with <code>Node line</code> menu.</p>
 
-    <hr><h2 id="color-bar-onoff">6.10, Color bar On/Off</h2>
+    <hr><h2 id="color-bar-onoff">6.11, Color bar On/Off</h2>
 
-    <p>The color bar becomes enable/disable (Fig. 8).</p>
+    <p>The color bar becomes enable/disable (Fig. 9).</p>
     <p><img src="figs/colorbar.jpg" align="middle" width="800" alt="" />
-      Fig. 8: Toggling the color bar with <code>Color bar On/Off</code> menu.</p>
+      Fig. 9: Toggling the color bar with <code>Color bar On/Off</code> menu.</p>
 
-    <hr><h2 id="stereogram">6.11, Stereogram</h2>
+    <hr><h2 id="stereogram">6.12, Stereogram</h2>
 
     <p>The stereogram (parallel eyes and cross eyes) becomes enabled/disabled 
-      (Fig. 9).</p>
+      (Fig. 10).</p>
     <dl>
       <p>None (Default)</p>
       <p>Parallel : Parallel-eyes stereogram</p>
       <p>Cross : Cross-eyes stereogram</p>
     </dl>
     <p><img src="figs/stereogram.jpg" align="middle" width="800" alt="" />
-      Fig. 9: The stereogram becomes enabled/disabled with <code>Stereogram</code> menu.</p>
+      Fig. 10: The stereogram becomes enabled/disabled with <code>Stereogram</code> menu.</p>
 
-    <hr><h2 id="tetrahedron">6.12, Tetrahedron</h2>
+    <hr><h2 id="tetrahedron">6.13, Tetrahedron</h2>
 
     <p>You change the scheme to divide into tetrahedra (<code>tetra # 1</code> as default). 
       It is experimental.</p>
 
-    <hr><h2 id="exit">6.13, Exit</h2>
+    <hr><h2 id="exit">6.14, Exit</h2>
 
     <p>This finishes <code>fermisurfer</code>.</p>
 
-    <hr><h2>6.14, Saving images</h2>
+    <hr><h2>6.15, Saving images</h2>
 
     <p><code>fermisurfer</code> does not have any functions to
       save images to a file.
@@ -504,9 +524,9 @@ <h3>5.2.2, For Windows</h3>
     <hr><h1><a name="gallery">7, Gallery</a></h1>
 
     <p>Contributions of each Fermi surfaces to the Hall effect in IrO$_2$ 
-      (Fig. 10. Provided by Mr. Wataru Sano in Arita group, RIKEN)</p>
+      (Fig. 11. Provided by Mr. Wataru Sano in Arita group, RIKEN)</p>
     <p><img src="figs/iro2.jpg" align="middle" width="800" alt="" />
-      Fig. 10: Contributions of each Fermi surfaces to the Hall effect</p>
+      Fig. 11: Contributions of each Fermi surfaces to the Hall effect</p>
 
     <hr><h1><a name="acknowledgment">8, Acknowledgment</a></h1>
 

diff --git a/doc/manual_right_ja.html b/doc/manual_right_ja.html
@@ -18,7 +18,7 @@
   <body bgcolor="CCFFCC">
 
     <center><h1>FermiSurferマニュアル</h1></center>
-    <center><h2>バージョン1.6</h2></center>
+    <center><h2>バージョン1.7</h2></center>
     <center><h2>河村光晶</h2></center>
 
     <hr><a name="hajimeni"><h1>1, はじめに</h1></a>
@@ -436,16 +436,36 @@ <h3>5.2.2, Windowsの場合</h3>
       図3: <code>Shift Fermi energy</code>メニューで
       Fermi エネルギーを0 Ryから0.1 Ryに変える.</p>
 
-    <hr><h2>6.6, Background color</h2>
+    <hr><h2>6.6, Set view</h2>
+
+    <p>視点を変更します.</p>
+    <dl>
+      <dt>Scale</dt>
+      <dd><p>図形のサイズを指定します.</p>
+      </dd>
+      <dt>Position</dt>
+      <dd><p>図形の上下位置を指定します.</p>
+      </dd>
+      <dt>Rotation</dt>
+      <dd><p>x,y,z軸周りの回転角を指定します.回転操作はz軸-y軸-x軸の順で行われます</p>
+      </dd>
+    </dl>
+    <p>それぞれのメニューを選択すると, はじめに現在の値が表示され, 
+      その後変更後の値を入れるプロンプトが現れます(図４).</p>
+    <p><img src="figs/setview.jpg" align="middle" width="800" alt="" />
+      図4: <code>Set view</code>メニューで
+      視点を変更する.</p>
+
+    <hr><h2>6.7, Background color</h2>
 
     <p>背景色を黒または白に切り替えます. 
-      Brillouin Zoneの枠線も白/黒と切り替わります (図4).</p>
+      Brillouin Zoneの枠線も白/黒と切り替わります (図5).</p>
     <p><img src="figs/background.jpg" align="middle" width="800" alt="" />
-      図4: <code>Background color</code>メニューで背景色を白/黒に切り替える.</p>
+      図5: <code>Background color</code>メニューで背景色を白/黒に切り替える.</p>
 
-    <hr><h2>6.7, Color scale mode</h2>
+    <hr><h2>6.8, Color scale mode</h2>
 
-    <p>Fermi面の色表示のさせ方を変更します(図5).</p>
+    <p>Fermi面の色表示のさせ方を変更します(図6).</p>
     <dl>
       <dt>Auto(デフォルト)</dt>
       <dd><p>カラースケールの範囲をFermi面上での物理量の最小値から最大値までとします.</p>
@@ -472,12 +492,12 @@ <h3>5.2.2, Windowsの場合</h3>
       </dd>
     </dl>
     <p><img src="figs/colorscale.jpg" align="middle" width="800" alt="" />
-      図5: <code>Color scale mode</code>メニュー.</p>
+      図6: <code>Color scale mode</code>メニュー.</p>
 
-    <hr><h2>6.8, Brillouin zone</h2>
+    <hr><h2>6.9, Brillouin zone</h2>
 
     <p>描画範囲をFirst Brillouin Zone/Primitive Brillouin Zoneと
-      切り替える事が出来ます (図6).</p>
+      切り替える事が出来ます (図7).</p>
     <dl>
       <dt>Fisrst Brillouin Zone</dt>
       <dd><p><span class="math">${\rm \Gamma}$</span> 
@@ -488,23 +508,23 @@ <h3>5.2.2, Windowsの場合</h3>
       </dd>
     </dl>
     <p><img src="figs/brillouinzone.jpg" align="middle" width="800" alt="" />
-      図6: <code>Brillouin zone</code>メニューでBrillouin領域のとり方を変更する.</p>
+      図7: <code>Brillouin zone</code>メニューでBrillouin領域のとり方を変更する.</p>
 
-    <hr><h2>6.9, Node line</h2>
+    <hr><h2>6.10, Node line</h2>
 
-    <p>物理量が0となるところに引く線(node line)のOn/Offを切り替えます(図7).</p>
+    <p>物理量が0となるところに引く線(node line)のOn/Offを切り替えます(図8).</p>
     <p><img src="figs/nodeline.jpg" align="middle" width="800" alt="" /> 
-      図7: <code>Node line</code>メニューでnode lineの表示/非表示を切り替える.</p>
+      図8: <code>Node line</code>メニューでnode lineの表示/非表示を切り替える.</p>
 
-    <hr><h2>6.10, Color bar On/Off</h2>
+    <hr><h2>6.11, Color bar On/Off</h2>
 
-    <p>カラーバーの表示/非表示を切り替えます(図8).</p>
+    <p>カラーバーの表示/非表示を切り替えます(図9).</p>
     <p><img src="figs/colorbar.jpg" align="middle" width="800" alt="" />
-      図8: <code>Color bar On/Off</code>メニューでカラーバーの表示/非表示を切り替える.</p>
+      図9: <code>Color bar On/Off</code>メニューでカラーバーの表示/非表示を切り替える.</p>
 
-    <hr><h2>6.11, Stereogram</h2>
+    <hr><h2>6.12, Stereogram</h2>
 
-    <p>裸眼立体視用の図の表示/非表示を切り替えます(図9).</p>
+    <p>裸眼立体視用の図の表示/非表示を切り替えます(図10).</p>
     <dl>
       <dt>None (デフォルト)</dt>
       <dd><p>立体視を無効にします.</p>
@@ -517,19 +537,19 @@ <h3>5.2.2, Windowsの場合</h3>
       </dd>
     </dl>
     <p><img src="figs/stereogram.jpg" align="middle" width="800" alt="" />
-      図9: <code>Stereogram</code>メニューで立体視用画像を表示する.</p>
+      図10: <code>Stereogram</code>メニューで立体視用画像を表示する.</p>
 
-    <hr><h2>6.12, Tetrahedron</h2>
+    <hr><h2>6.13, Tetrahedron</h2>
 
     <p>四面体の切り方を変えます(デフォルトは<code>tetra # 1</code>). 
       図が綺麗になる可能性がありますが, 
       多くの場合は逆に図がギザギザして汚くなるようです.</p>
 
-    <hr><h2>6.13, Exit</h2>
+    <hr><h2>6.14, Exit</h2>
 
     <p>Fermi Surferを終了します.</p>
 
-    <hr><h2>6.14, 画像の保存方法</h2>
+    <hr><h2>6.15, 画像の保存方法</h2>
 
     <p><code>fermisurfer</code>には画像をファイル出力する機能はありません.
     お使いのPCにあった方法でスクリーンショットを取得して
@@ -538,10 +558,10 @@ <h3>5.2.2, Windowsの場合</h3>
 
     <hr><a name="garally"><h1>7, ギャラリー</h1></a>
 
-    <p>IrO$_2$のHall係数に対するFermi面上の各軌道からの寄与 (図10). 
+    <p>IrO$_2$のHall係数に対するFermi面上の各軌道からの寄与 (図11). 
       理化学研究所 有田グループ 佐野航氏提供).</p>
     <p><img src="figs/iro2.jpg" align="middle" width="800" alt="" />
-      図10: IrO$_2$のHall係数に対するFermi面上の各軌道からの寄与.</p>
+      図11: IrO$_2$のHall係数に対するFermi面上の各軌道からの寄与.</p>
 
     <hr><a name="acknoledge"><h1>8, 謝辞</h1></a>