View source for ALPS using the command line/ja

{{Languages|ALPS_using_the_command_line}}


= 入力ファイルの準備 =

<!--Since the XML format of the job and task files is probably not what you want to deal with on a daily basis, the parameter2xml tool lets you specify the simulation parameters in a plain text file which is converted to the XML format for your conveniece.-->

XMLフォーマットで書かれたジョブ、タスクファイルは可読性に乏しく日常の作業には向いていません。parameter2xmlはテキストで書かれたシミュレーション用のパラメータを容易にXMLフォーマットに変換できるツールです。

<!--The parameter2xml tool transforms a plain text parameter file into the above XML format,thereby creating the job and all necessary task files. The parameter file consists of a number of parameter assignments of the form:-->
parameter2xmlツールはテキストベースで書かれたパラメータをXML形式に変換し、シミュレーションに必要なファイルを生成します。パラメータの記述は、次に示す形式に従います。



  MODEL="Ising";
  SWEEPS=1000;
  THERMALIZATION=100; 
  WORK_FACTOR=L*SWEEPS;
  { L=10; T=0.1; }
  { L=20; T=0.05; }

<!--where each group of assignments inside a block of curly braces {...} indicates a set of parameters for a single simulation. Assignments outside of a block of curly braces are valid globally for all simulation after the point of definition. Strings are given in double quotes, as in "Ising".-->

中括弧{...}内で指定することができる複数のパラメータは、ある特定のシミュレーションのためのローカルなパラメータになります。中括弧の外で与えられるパラメータは、全てのシミュレーションに対して有効なグローバルなパラメータになります。文字列を指定するときは"Ising"のように二重引用符を用います。

SEEDとWORK_FACTORは特別な意味を持ったパラメータです。

{| border="1" cellpadding="5" cellspacing="0"
|| '''Parameter'''
|| '''Default'''
|| '''Meaning'''
|-
|| SEED
| align="center"| 0
|| モンテカルロ計算に使用する乱数種に関する数値です。モンテカルロ計算がおこなわれると、この値は１ずつ増分されます。
|-
|| WORK_FACTOR
| align="center"| 1
|| シミュレーションのロードバランシングをおこなう負荷分散係数です。
|}


<!--The syntax to invoke parameter2xml is:-->
parameter2xmlを実行する構文は次の通りです。
  parameter2xml [-f] parameterfile [xmlfileprefix]

<!--which converts a parameterfile into a set of XML files, starting with the prefix given as optional second argument. The default for the second argument is the name as the parameterfile.-->
parameterfileからXMLファイルを生成する際、オプションの2番目の引数[xmlfileprefix]を与えると、xmlfileprefixから始まるXMLファイルが生成されます。省略時は、parameterfileから始まるXMLファイルが生成されます。

<!--The parameter2xml tool checks the existence of output XML files, and ask the user if he/she really wants to overwrite the input files.  One can force parameter2xml to overwrite the input XMLs by "-f" option.-->
parameter2xmlは既に存在しているXMLファイルのチェックをおこないます。既存のファイルに上書きしてXMLファイルを生成する場合は、オプション"-f"を付加してください。

=  プログラムの起動  =
==  シミュレーションの実行（シリアル）  ==
<!--==  Running the simulation on a serial machine  ==-->

<!--The simulation is started by first creating the job file, and then giving the name of the XML job file as argument to the program. In our example, the program is called my_program and the sequence for running it is:-->
ALPSライブラリを利用したプログラムでのシミュレーションは、まずXML形式のジョブファイルを生成することから始まります。次の例では、3つのパラメータセットを含むジョブファイルを"para"、XMLファイル名を"job"として、あるプログラムmy_programを実行させています。

  parameter2xml parm job
  my_program job.in.xml

<!--The results will be stored in a file job.out.xml, which refers to the files job.task1.out.xml, job.task2.out.xml and job.task3.out.xml for the results of the three simulations.-->

結果として、３種類のシミュレーション結果"job.task1.out.xml"、"job.task2.out.xml"、"job.task3.out.xml"が格納されている"job.out.xml"が生成されます。

=== コマンドラインのオプション ===

<!--The program takes a number of command line options, to control the behavior of the scheduler. These options are most useful for Monte Carlo simulations.-->

プログラムには、スケジューラを制御するためのオプションを与えることができます。これらのオプションはモンテカルロシミュレーションの利便性を高めます。

{| border="1" cellpadding="5" cellspacing="0"

|| '''Option'''
|| '''Default'''
|| '''Description'''
|-
|| --time-limit ''timelimit''
| align="center"| infinity
|| <!--gives the time (in seconds) which the program should run before writing a final checkpoint and exiting.-->プログラムが終了、もしくは最終チェックポイントを生成するまでの時間（秒）
|-
|| --checkpoint-time ''checkpointtime''
| align="center"| 1800
|| <!--gives the time (in seconds) after which the program should write a checkpoint.-->プログラムがチェックポイントを生成する時間間隔（秒）
|-
|| --Tmin ''checkingtime''
| align="center"| 60
|| <!--gives the minimum time (in seconds) which the scheduler waits before checking (again) whether a simulation is finished.-->スケジューラがシミュレーションが終了したかどうか確認するまでの最小待ち時間（秒）
|-
|| --Tmax ''checkingtime''
| align="center"| 900
|| <!--gives the maximum time (in seconds) which the scheduler waits before checking (again) whether a simulation is finished.-->スケジューラがシミュレーションが終了したかどうか確認するまでの最大待ち時間（秒）
|-
|| --write-xml 
| align="center"|
|| <!--with this option the result will be written to the .out.xml files, while otherwise it is only written to the hdf5-files.-->このオプションが指定されると計算結果は、.out.xmlファイルにも書き込まれます。通常はhdf5ファイルにのみ書き込まれます。
|}

==  シミュレーションの実行（並列）  ==

<!--is as easy as running it on a single machine. We will give the example using MPI. After starting the MPI environment (using e.g. lamboot for [http://www.lam-mpi.org/ LAM MPI]), you run the program in parallel using mpirun. In our example, e.g. to run it on four processes you do:-->
MPIによる並列実行方法もシリアル版と同様に非常にシンプルです。MPI環境（例：lamboot  [http://www.lam-mpi.org/ LAM MPI]）をスタートし、"mpirun"を用いた並列計算をおこないます。4並列で実行する場合の実行構文例を次に示します。

  parameter2xml parm job 
  mpirun -np 4 my_program --mpi job.in.xml

=== コマンドラインのオプション ===

<!--In addition to the command line options for the sequential program there are two more for the parallel program:-->
上記に示した逐次プログラムのオプションに加えて、並列計算用に２つのオプションがあります。

{| border="1" cellpadding="5" cellspacing="0"

|| '''Option'''
|| '''Default'''
|| '''Description'''
|-
|-
|| --mpi
||
|| MPIモードで実行することを指定します。
|-
|| --Nmin ''numprocs''
| align="center"| 1
|| シミュレーションに割り当てる最小のプロセッサー数を与えます。
|-
|| --Nmax ''numprocs''
| align="center"| infinity
|| シミュレーションに割り当てる最大のプロセッサー数を与えます。
|}

<!--If there are more processors available than simulations, more than one Monte Carlo run will be started for each simulation.-->
シミュレーション数より多くのプロセッサー数が指定された場合は、各シミュレーションで、複数のモンテカルロ計算が開始されます。

=  シミュレーション結果の解析 =

<!--During the simulations expectation values of a couple of observables (specified and implemented in the simulation code) are measured and stored in the respective task files. To archive the task files produced from a simulation and to extract data from these files or the archive respectively a couple of tools are documented in the following.-->

シミュレーションがおこなわれると、指定した物理量、並びにシミュレーションコードに実装されている物理量が測定され、それぞれのタスクファイルに格納されます。シミュレーションから得られるタスクファイルのアーカイブ化、それぞれのタスクファイル、アーカイブからデータを摘出する方法は次の記述に従います。

==  convert2xml  ==

シミュレーション出力ファイルには、全計算がおこなわれた後の計算結果がだけが格納されています。ここのモンテカルロステップでの計算の詳細は、各チェックポイント情報を格納しているチェックポイントファイルをXML形式に変換することによって知ることが可能です。convert2xmlツールを次のように使用します。
<!--The simulation output files only contain the collected measurements from all runs. Details about the individual Monte Carlo runs for each simulation can be obtained by converting the checkpoint files to XML, using the convert2xml tool, e.g.:-->

  convert2xml run-file

<!--his will produce an xml file of the task, containing information extracted from this Monte Carlo run.-->
この操作によってモンテカルロ計算から摘出された情報を含む、XML形式のタスクファイルが生成されます。


==  観測量の解析  ==

コマンドライン用の解析プログラムとして、dirloop_sse_evalute、spin_mc_evaluate、worm_evaluate、fulldiag_evaluate、qwl_evaluateがあります。（dirloop_sse_evaluate、spinmc_evaluate、worm_evaluateの３つは同じ構文です。）使用方法は、次の通りです。

 spinmc_evalute [--write-xml] job.task1.out.xml [job.task2.out.xml ... ]

格納されているモンテカルロのデータからシミュレーション中では計算されない比熱、圧縮率等の追加物理量を計算します。オプション"--write-xml"を使用すると、すべての情報が.out.xmlファイルに書き込まれます。この指定が無い場合、計算結果はhdf5ファイルにのみ出力されます。

<!--For the syntax of the other two binaries (fulldiag_evaluate and qwl_evaluate) please see the Tutorials on [[ALPS_2_Tutorials:MC-06_QWL | QWL]] and [[ALPS_2_Tutorials:ED-06_FullDiagonalization | ED]].-->
fulldiag_evaluateとqwl_evaluateの解析プログラムに関しては、[[ALPS_2_Tutorials:MC-06_QWL/ja | QWL]]と[[ALPS_2_Tutorials:ED-06_FullDiagonalization/ja | ED]]を参照してください。

<!--The structure of the evalute programs is relatively easy. It is straight forward to create or modify such evaluate-programs.
The following example reads the expectation values of the particle number operators n and n2 of the simulation of a bosonic Hubbard model, calculates the expectation value of the compressibility and writes it back to the checkpoint.-->

解析プログラムの構文はそれぞれ非常にシンプルで、直感的に生成、修正が可能です。次に示す例は、bosonic Hubbardモデルのシミュレーションで得られた粒子数n,n2の期待値を読み込み、圧縮率の期待値を計算し、チェックポイントに戻す処理をおこなっています。

 #include <alps/scheduler.h>
 #include <alps/alea.h>
  
 void evaluate(const boost::filesystem::path&amp; p, std::ostream&amp; out) {
   alps::ProcessList nowhere;
   alps::scheduler::MCSimulation sim(nowhere,p);
  
   // read in parameters
   alps::Parameters parms=sim.get_parameters();
   double beta=parms.defined("beta") ? static_cast<double>(parms["beta"]) : (1./static_cast<double>(parms["T"]));             
  
   // determine compressibility
   alps::RealObsevaluator n  = sim.get_measurements()["Particle number"];
   alps::RealObsevaluator n2 = sim.get_measurements()["Particle number^2"];
   alps::RealObsevaluator kappa= beta*(n2 - n*n);  
   kappa.rename("Compressibility");
  
   // write compressibility back to checkpoint  
   sim << kappa;
   sim.checkpoint(p);
 }
  
 int main(int argc, char** argv)
 {
   alps::scheduler::BasicFactory<alps::scheduler::MCSimulation,alps::scheduler::DummyMCRun> factory;
   alps::scheduler::init(factory);
   boost::filesystem::path p(argv[1],boost::filesystem::native);
   evaluate(p,std::cout);
 }

<!--Note that ALPS 2 provides much easier analysis and evaluation of data in Python, and this C++ example should only be used by those who require analysis in their C++ programs.-->
ALPS2は、Pythonを使用することで、データの解析が大変容易になりました。上記のC++によるサンプルはC++による解析が必要な場合にのみ使用されます。