Skip to content

Commit ca0e8b7

Browse files
committed
Update manuals
1 parent 7f89ca4 commit ca0e8b7

33 files changed

+52531
-130341
lines changed

doc/figs/background.eps

-12,382
This file was deleted.

doc/figs/background.odg

-197 KB
Binary file not shown.

doc/figs/background.svg

+85
Loading

doc/figs/band.eps

-10,308
This file was deleted.

doc/figs/band.odg

-167 KB
Binary file not shown.

doc/figs/band.svg

+2,500
Loading

doc/figs/brillouinzone.eps

-17,101
This file was deleted.

doc/figs/brillouinzone.odg

-247 KB
Binary file not shown.

doc/figs/brillouinzone.svg

+3,369
Loading

doc/figs/colorbar.eps

-14,353
This file was deleted.

doc/figs/colorbar.odg

-211 KB
Binary file not shown.

doc/figs/colorbar.svg

+3,186
Loading

doc/figs/colorscale.eps

-23,116
This file was deleted.

doc/figs/colorscale.odg

-435 KB
Binary file not shown.

doc/figs/colorscale.svg

+10,048
Loading

doc/figs/iro2.eps

-9,741
This file was deleted.

doc/figs/iro2.odg

-218 KB
Binary file not shown.

doc/figs/iro2.svg

+10,276
Loading

doc/figs/nodeline.eps

-14,610
This file was deleted.

doc/figs/nodeline.odg

-205 KB
Binary file not shown.

doc/figs/nodeline.svg

+3,526
Loading

doc/figs/setview.svg

+8,580
Loading

doc/figs/shift.eps

-11,472
This file was deleted.

doc/figs/shift.odg

-173 KB
Binary file not shown.

doc/figs/shift.svg

+102
Loading

doc/figs/start.eps

-3,627
This file was deleted.

doc/figs/start.odg

-92.9 KB
Binary file not shown.

doc/figs/start.svg

+2,852
Loading

doc/figs/stereogram.eps

-13,579
This file was deleted.

doc/figs/stereogram.odg

-240 KB
Binary file not shown.

doc/figs/stereogram.svg

+7,915
Loading

doc/manual_right_en.html

+48-28
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
<body bgcolor="CCFFCC">
1919

2020
<center><h1>Manual for FermiSurfer</h1></center>
21-
<center><h2>Version 1.6</h2></center>
21+
<center><h2>Version 1.7</h2></center>
2222
<center><h2>Mitsuaki Kawamura</h2></center>
2323

2424
<hr>
@@ -206,10 +206,9 @@ <h1><a name="introduction">1, Introduction</a></h1>
206206
an input file for XCrysDen (the bxsf format)
207207
by using the utility program <code>bxsf2frmsf</code>.
208208
</p>
209-
<p>使い方は次のとおりです.<code>examples/</code>ディレクトリにある<code>pb.bxsf</code>
210-
ファイルを例として使います.</p>
209+
<p>The usage is as follow (we use <code>examples/pb.bxsf</code> as an example.):</p>
211210

212-
<h3>5.2.1, For Linuxの場合</h2>
211+
<h3>5.2.1, For Linux</h2>
213212

214213
<p>You can launch generated executable as follows:</p>
215214
<pre><code>
@@ -285,7 +284,7 @@ <h3>5.2.2, For Windows</h3>
285284
FILE* fo;
286285
int ibnd, ik1, ik2, ik3;
287286

288-
fo = fopen(sample.frmsf”, “w”);
287+
fo = fopen("sample.frmsf", "w");
289288
ierr = fprintf(fo, &quot;%d %d %d\n&quot;, nk1, nk2, nk3);
290289
ierr = fprintf(fo, &quot;%d\n&quot;, iswitch);
291290
ierr = fprintf(fo, &quot;%d\n&quot;, nbnd);
@@ -422,17 +421,38 @@ <h3>5.2.2, For Windows</h3>
422421
Fig. 3: The Fermi energy is set from 0 Ry to 0.1 Ry
423422
with <code>Shift Fermi energy</code> menu</p>
424423

425-
<hr><h2 id="background-color">6.6, Background color</h2>
424+
<hr><h2 id="setview">6.6, Set view</h2>
425+
426+
<p>Changing the view point.</p>
427+
<dl>
428+
<dt>Scale</dt>
429+
<dd><p>Change the size of the figure.</p>
430+
</dd>
431+
<dt>Position</dt>
432+
<dd><p>Change the xy position of the figure.</p>
433+
</dd>
434+
<dt>Rotation</dt>
435+
<dd><p>Change angles at x-, y-, z- axis.
436+
Rotaions are performed as z-y-x axis.</p>
437+
</dd>
438+
</dl>
439+
<p>In each menu, first the current value is printed.
440+
then a prompt to input the new value appears (Fig. 4).</p>
441+
442+
<p><img src="figs/setview.jpg" align="middle" width="800" alt="" />
443+
Fig. 4: Modify the view point by using <code>Set view</code> menu</p>
444+
445+
<hr><h2 id="background-color">6.7, Background color</h2>
426446

427447
<p>The background color is toggled between black and white;
428448
the edge of the Brillouin Zone is also toggled between white and black
429-
(Fig. 4).</p>
449+
(Fig. 5).</p>
430450
<p><img src="figs/background.jpg" align="middle" width="800" alt="" />
431-
Fig. 4: The background color is toggled with <code>Background color</code> menu.</p>
451+
Fig. 5: The background color is toggled with <code>Background color</code> menu.</p>
432452

433-
<hr><h2 id="color-scale-mode">6.7, Color scale mode</h2>
453+
<hr><h2 id="color-scale-mode">6.8, Color scale mode</h2>
434454

435-
<p>It turns color pattern on Fermi surfaces (Fig. 5).</p>
455+
<p>It turns color pattern on Fermi surfaces (Fig. 6).</p>
436456
<dl>
437457
<p>Auto(default) : It makes blue as the minimum on Fermi surfaces
438458
and red as the maximum on them.</p>
@@ -447,55 +467,55 @@ <h3>5.2.2, For Windows</h3>
447467
$\rightarrow$ cyan $\rightarrow$ blue $\rightarrow$ magenta $\rightarrow$ red.</p>
448468
</dl>
449469
<p><img src="figs/colorscale.jpg" align="middle" width="800" alt="" />
450-
Fig. 5: <code>Color scale mode</code> menu.</p>
470+
Fig. 6: <code>Color scale mode</code> menu.</p>
451471

452-
<hr><h2 id="brillouin-zone">6.8, Brillouin zone</h2>
472+
<hr><h2 id="brillouin-zone">6.9, Brillouin zone</h2>
453473

454-
<p>You choose Brillouin-zone type as follows (Fig. 6):</p>
474+
<p>You choose Brillouin-zone type as follows (Fig. 7):</p>
455475
<dl>
456476
<p>First Brillouin Zone : The region surrounded by Bragg's planes
457477
the nearest to ${\rm \Gamma}$ point.</p>
458478
<p>Primitive Brillouin Zone : A hexahedron whose corner is the reciprocal lattice point.</p>
459479
</dl>
460480
<p><img src="figs/brillouinzone.jpg" align="middle" width="800" alt="" />
461-
Fig. 6: You can change the type of the Brillouin zone
481+
Fig. 7: You can change the type of the Brillouin zone
462482
with <code>Brillouin zone</code> menu.</p>
463483

464-
<hr><h2 id="node-line">6.9, Node line</h2>
484+
<hr><h2 id="node-line">6.10, Node line</h2>
465485

466486
<p>The line on which the matrix element becomes 0 (we call it node line)
467-
becomes enable/disable (Fig. 7).</p>
487+
becomes enable/disable (Fig. 8).</p>
468488
<p><img src="figs/nodeline.jpg" align="middle" width="800" alt="" />
469-
Fig. 7: Toggling the node line with <code>Node line</code> menu.</p>
489+
Fig. 8: Toggling the node line with <code>Node line</code> menu.</p>
470490

471-
<hr><h2 id="color-bar-onoff">6.10, Color bar On/Off</h2>
491+
<hr><h2 id="color-bar-onoff">6.11, Color bar On/Off</h2>
472492

473-
<p>The color bar becomes enable/disable (Fig. 8).</p>
493+
<p>The color bar becomes enable/disable (Fig. 9).</p>
474494
<p><img src="figs/colorbar.jpg" align="middle" width="800" alt="" />
475-
Fig. 8: Toggling the color bar with <code>Color bar On/Off</code> menu.</p>
495+
Fig. 9: Toggling the color bar with <code>Color bar On/Off</code> menu.</p>
476496

477-
<hr><h2 id="stereogram">6.11, Stereogram</h2>
497+
<hr><h2 id="stereogram">6.12, Stereogram</h2>
478498

479499
<p>The stereogram (parallel eyes and cross eyes) becomes enabled/disabled
480-
(Fig. 9).</p>
500+
(Fig. 10).</p>
481501
<dl>
482502
<p>None (Default)</p>
483503
<p>Parallel : Parallel-eyes stereogram</p>
484504
<p>Cross : Cross-eyes stereogram</p>
485505
</dl>
486506
<p><img src="figs/stereogram.jpg" align="middle" width="800" alt="" />
487-
Fig. 9: The stereogram becomes enabled/disabled with <code>Stereogram</code> menu.</p>
507+
Fig. 10: The stereogram becomes enabled/disabled with <code>Stereogram</code> menu.</p>
488508

489-
<hr><h2 id="tetrahedron">6.12, Tetrahedron</h2>
509+
<hr><h2 id="tetrahedron">6.13, Tetrahedron</h2>
490510

491511
<p>You change the scheme to divide into tetrahedra (<code>tetra # 1</code> as default).
492512
It is experimental.</p>
493513

494-
<hr><h2 id="exit">6.13, Exit</h2>
514+
<hr><h2 id="exit">6.14, Exit</h2>
495515

496516
<p>This finishes <code>fermisurfer</code>.</p>
497517

498-
<hr><h2>6.14, Saving images</h2>
518+
<hr><h2>6.15, Saving images</h2>
499519

500520
<p><code>fermisurfer</code> does not have any functions to
501521
save images to a file.
@@ -504,9 +524,9 @@ <h3>5.2.2, For Windows</h3>
504524
<hr><h1><a name="gallery">7, Gallery</a></h1>
505525

506526
<p>Contributions of each Fermi surfaces to the Hall effect in IrO$_2$
507-
(Fig. 10. Provided by Mr. Wataru Sano in Arita group, RIKEN)</p>
527+
(Fig. 11. Provided by Mr. Wataru Sano in Arita group, RIKEN)</p>
508528
<p><img src="figs/iro2.jpg" align="middle" width="800" alt="" />
509-
Fig. 10: Contributions of each Fermi surfaces to the Hall effect</p>
529+
Fig. 11: Contributions of each Fermi surfaces to the Hall effect</p>
510530

511531
<hr><h1><a name="acknowledgment">8, Acknowledgment</a></h1>
512532

doc/manual_right_ja.html

+44-24
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
<body bgcolor="CCFFCC">
1919

2020
<center><h1>FermiSurferマニュアル</h1></center>
21-
<center><h2>バージョン1.6</h2></center>
21+
<center><h2>バージョン1.7</h2></center>
2222
<center><h2>河村光晶</h2></center>
2323

2424
<hr><a name="hajimeni"><h1>1, はじめに</h1></a>
@@ -436,16 +436,36 @@ <h3>5.2.2, Windowsの場合</h3>
436436
図3: <code>Shift Fermi energy</code>メニューで
437437
Fermi エネルギーを0 Ryから0.1 Ryに変える.</p>
438438

439-
<hr><h2>6.6, Background color</h2>
439+
<hr><h2>6.6, Set view</h2>
440+
441+
<p>視点を変更します.</p>
442+
<dl>
443+
<dt>Scale</dt>
444+
<dd><p>図形のサイズを指定します.</p>
445+
</dd>
446+
<dt>Position</dt>
447+
<dd><p>図形の上下位置を指定します.</p>
448+
</dd>
449+
<dt>Rotation</dt>
450+
<dd><p>x,y,z軸周りの回転角を指定します.回転操作はz軸-y軸-x軸の順で行われます</p>
451+
</dd>
452+
</dl>
453+
<p>それぞれのメニューを選択すると, はじめに現在の値が表示され,
454+
その後変更後の値を入れるプロンプトが現れます(図4).</p>
455+
<p><img src="figs/setview.jpg" align="middle" width="800" alt="" />
456+
図4: <code>Set view</code>メニューで
457+
視点を変更する.</p>
458+
459+
<hr><h2>6.7, Background color</h2>
440460

441461
<p>背景色を黒または白に切り替えます.
442-
Brillouin Zoneの枠線も白/黒と切り替わります (図4).</p>
462+
Brillouin Zoneの枠線も白/黒と切り替わります (図5).</p>
443463
<p><img src="figs/background.jpg" align="middle" width="800" alt="" />
444-
図4: <code>Background color</code>メニューで背景色を白/黒に切り替える.</p>
464+
図5: <code>Background color</code>メニューで背景色を白/黒に切り替える.</p>
445465

446-
<hr><h2>6.7, Color scale mode</h2>
466+
<hr><h2>6.8, Color scale mode</h2>
447467

448-
<p>Fermi面の色表示のさせ方を変更します(図5).</p>
468+
<p>Fermi面の色表示のさせ方を変更します(図6).</p>
449469
<dl>
450470
<dt>Auto(デフォルト)</dt>
451471
<dd><p>カラースケールの範囲をFermi面上での物理量の最小値から最大値までとします.</p>
@@ -472,12 +492,12 @@ <h3>5.2.2, Windowsの場合</h3>
472492
</dd>
473493
</dl>
474494
<p><img src="figs/colorscale.jpg" align="middle" width="800" alt="" />
475-
図5: <code>Color scale mode</code>メニュー.</p>
495+
図6: <code>Color scale mode</code>メニュー.</p>
476496

477-
<hr><h2>6.8, Brillouin zone</h2>
497+
<hr><h2>6.9, Brillouin zone</h2>
478498

479499
<p>描画範囲をFirst Brillouin Zone/Primitive Brillouin Zoneと
480-
切り替える事が出来ます (図6).</p>
500+
切り替える事が出来ます (図7).</p>
481501
<dl>
482502
<dt>Fisrst Brillouin Zone</dt>
483503
<dd><p><span class="math">${\rm \Gamma}$</span>
@@ -488,23 +508,23 @@ <h3>5.2.2, Windowsの場合</h3>
488508
</dd>
489509
</dl>
490510
<p><img src="figs/brillouinzone.jpg" align="middle" width="800" alt="" />
491-
図6: <code>Brillouin zone</code>メニューでBrillouin領域のとり方を変更する.</p>
511+
図7: <code>Brillouin zone</code>メニューでBrillouin領域のとり方を変更する.</p>
492512

493-
<hr><h2>6.9, Node line</h2>
513+
<hr><h2>6.10, Node line</h2>
494514

495-
<p>物理量が0となるところに引く線(node line)のOn/Offを切り替えます(図7).</p>
515+
<p>物理量が0となるところに引く線(node line)のOn/Offを切り替えます(図8).</p>
496516
<p><img src="figs/nodeline.jpg" align="middle" width="800" alt="" />
497-
図7: <code>Node line</code>メニューでnode lineの表示/非表示を切り替える.</p>
517+
図8: <code>Node line</code>メニューでnode lineの表示/非表示を切り替える.</p>
498518

499-
<hr><h2>6.10, Color bar On/Off</h2>
519+
<hr><h2>6.11, Color bar On/Off</h2>
500520

501-
<p>カラーバーの表示/非表示を切り替えます(図8).</p>
521+
<p>カラーバーの表示/非表示を切り替えます(図9).</p>
502522
<p><img src="figs/colorbar.jpg" align="middle" width="800" alt="" />
503-
図8: <code>Color bar On/Off</code>メニューでカラーバーの表示/非表示を切り替える.</p>
523+
図9: <code>Color bar On/Off</code>メニューでカラーバーの表示/非表示を切り替える.</p>
504524

505-
<hr><h2>6.11, Stereogram</h2>
525+
<hr><h2>6.12, Stereogram</h2>
506526

507-
<p>裸眼立体視用の図の表示/非表示を切り替えます(図9).</p>
527+
<p>裸眼立体視用の図の表示/非表示を切り替えます(図10).</p>
508528
<dl>
509529
<dt>None (デフォルト)</dt>
510530
<dd><p>立体視を無効にします.</p>
@@ -517,19 +537,19 @@ <h3>5.2.2, Windowsの場合</h3>
517537
</dd>
518538
</dl>
519539
<p><img src="figs/stereogram.jpg" align="middle" width="800" alt="" />
520-
図9: <code>Stereogram</code>メニューで立体視用画像を表示する.</p>
540+
図10: <code>Stereogram</code>メニューで立体視用画像を表示する.</p>
521541

522-
<hr><h2>6.12, Tetrahedron</h2>
542+
<hr><h2>6.13, Tetrahedron</h2>
523543

524544
<p>四面体の切り方を変えます(デフォルトは<code>tetra # 1</code>).
525545
図が綺麗になる可能性がありますが,
526546
多くの場合は逆に図がギザギザして汚くなるようです.</p>
527547

528-
<hr><h2>6.13, Exit</h2>
548+
<hr><h2>6.14, Exit</h2>
529549

530550
<p>Fermi Surferを終了します.</p>
531551

532-
<hr><h2>6.14, 画像の保存方法</h2>
552+
<hr><h2>6.15, 画像の保存方法</h2>
533553

534554
<p><code>fermisurfer</code>には画像をファイル出力する機能はありません.
535555
お使いのPCにあった方法でスクリーンショットを取得して
@@ -538,10 +558,10 @@ <h3>5.2.2, Windowsの場合</h3>
538558

539559
<hr><a name="garally"><h1>7, ギャラリー</h1></a>
540560

541-
<p>IrO$_2$のHall係数に対するFermi面上の各軌道からの寄与 (図10).
561+
<p>IrO$_2$のHall係数に対するFermi面上の各軌道からの寄与 (図11).
542562
理化学研究所 有田グループ 佐野航氏提供).</p>
543563
<p><img src="figs/iro2.jpg" align="middle" width="800" alt="" />
544-
図10: IrO$_2$のHall係数に対するFermi面上の各軌道からの寄与.</p>
564+
図11: IrO$_2$のHall係数に対するFermi面上の各軌道からの寄与.</p>
545565

546566
<hr><a name="acknoledge"><h1>8, 謝辞</h1></a>
547567

0 commit comments

Comments
 (0)