SpM
program solves the linear equation with respect to
for given
.
+
SpM
program solves the linear equation with respect to
for given
.
Because of ill-conditioned nature of the matrix
, a simple treatment of this equation is numerically unstable.
For example, the solution using the Moore-Penrose pseudo-inverse matrix
results in NaN.
Even if one manages to derive a definite solution, it is quite sensitive to numerical noise and often breaks preconditions that any physical spectra must satisfy.
This becomes particularly problematic when
is evaluated by quantum Monte Carlo technique.
SpM
provides a physical solution which fulfills the equation of concern within a certain accuracy.
+
SpM
provides a physical solution which fulfills the equation of concern within a certain accuracy.
The solution satisfies the constraints such as sum rule and nonnegativity.
-The engine of SpM
program uses the method of L1-norm regularization to separate relevant information in from irrelevant one which makes the spectrum unphysical. This process is automatically done without hand-tuning parameters.
SpM
program uses the method of L1-norm regularization to separate relevant information in For details, see the original article
J. Otsuki, M. Ohzeki, H. Shinaoka, K. Yoshimi, @@ -99,12 +90,14 @@Related Topics
The variables for which default value is not given are mandatory.
In SPM, the values of Green’s function is only used for calculation, i.e. tau is automatically determined by the beta and the step. Please indicate the column number where the values of G(tau) are -stored by “column” in the prameter file.
+stored by “column” in the parameter file. @@ -262,12 +253,14 @@Stable version
-You can download a stable version of the SpM
program in https://github.com/SpM-lab/SpM/releases. After download the archive, decompress it by
$ tar zxvf v1.0.tar.gz
+You can download a stable version of the SpM
program in https://github.com/SpM-lab/SpM/releases. After download the archive, decompress it by
+$ tar zxvf v1.0.tar.gz
Latest codes
You can get the latest codes from our GitHub repository. Execute the following command
-$ git clone https://github.com/SpM-lab/SpM.git spm.src
+$ git clone https://github.com/SpM-lab/SpM.git spm.src
-and then the source codes are downloaded in the directory spm.src
.
+and then the source codes are downloaded in the directory spm.src
.
$ mkdir spm.build && cd spm.build
+$ mkdir spm.build && cd spm.build
-We assume that spm.build
is located on the same level as spm.src
.
+We assume that spm.build
is located on the same level as spm.src
.
- Call cmake
-$ cmake ../spm.src
+$ cmake ../spm.src
-and all necessary files including Makefile
are created according to your system configuration. [any cmake options?]
+and all necessary files including Makefile
are created according to your system configuration. [any cmake options?]
- Now, you can compile the codes by
-$ make
+$ make
-The executable file SpM.out
is created in the spm.build/src
directory.
+The executable file SpM.out
is created in the spm.build/src
directory.
1.4. Test¶
Some sample data are provided for test calculations.
-Just enter into samples/fermion
directory and execute it by
-$ ./run.sh
+Just enter into samples/fermion
directory and execute it by
+$ ./run.sh
-You may need to change the parameter file_exe="../SpM.out"
in the script (absolute or relative path to SpM.out
) according to your environment.
-If succeeded, results including graphs in EPS format are generated in output
directory.
+
You may need to change the parameter file_exe="../SpM.out"
in the script (absolute or relative path to SpM.out
) according to your environment.
+If succeeded, results including graphs in EPS format are generated in output
directory.
For details of the sample script, see Tutorials.
@@ -157,12 +148,14 @@ Related Topics
@@ -173,7 +166,7 @@ Quick search
©2017, Junya Otsuki, Kazuyoshi Yoshimi, Hiroshi Shinaoka.
|
- Powered by Sphinx 1.6.5
+ Powered by Sphinx 1.7.1
& Alabaster 0.7.10
|
diff --git a/docs/manual/build/html/docs/outputfile.html b/docs/manual/build/html/docs/outputfile.html
index 18754e7..5777256 100644
--- a/docs/manual/build/html/docs/outputfile.html
+++ b/docs/manual/build/html/docs/outputfile.html
@@ -4,20 +4,12 @@
+
6. Output files — SpM 1.0.0 documentation
-
+
@@ -30,8 +22,7 @@
-
-
+
@@ -41,10 +32,10 @@
6. Output files¶
-After computation is done, numerical results are stored in directory output
.
+After computation is done, numerical results are stored in directory output
.
6.1. List of files¶
-output
+output
├── spectrum.dat
├── lambda_dep.dat
├── find_lambda_opt.dat
@@ -69,8 +60,8 @@ 6.1. List of fileslambda_*
-In particular, the directory lambda_opt
is for the optimal values of lambda, and the other directories ending with numbers, e.g. lambda_1.00e+00
, contain results for the specific value of lambda.
+More detailed results for a given value lambda are stored in directory lambda_*
+In particular, the directory lambda_opt
is for the optimal values of lambda, and the other directories ending with numbers, e.g. lambda_1.00e+00
, contain results for the specific value of lambda.
6.2. Details of each files¶
@@ -84,8 +75,8 @@ 6.2. Details of each files
- 2nd column:

-ex.) calculated results for fermion sample outputted as samles/fermion/spectrum.dat
.
-# lambda=1.585e-02 (l=19)
+ex.) calculated results for fermion sample outputted as samles/fermion/spectrum.dat
.
+# lambda=1.585e-02 (l=19)
-4.00000e+00 0.00000e+00
-3.99200e+00 0.00000e+00
-3.98400e+00 0.00000e+00
@@ -104,8 +95,8 @@ 6.2. Details of each files,
(the second term in
)
- 5th column: not used
-ex.) calculated results for fermion sample outputted as samles/fermion/lambda_dep.dat
.
-1.00000e+02 1.09110e-01 1.13080e-01 4.81361e-02 0.00000e+00
+ex.) calculated results for fermion sample outputted as samles/fermion/lambda_dep.dat
.
+1.00000e+02 1.09110e-01 1.13080e-01 4.81361e-02 0.00000e+00
6.30957e+01 1.08854e-01 1.12824e-01 4.81376e-02 0.00000e+00
3.98107e+01 1.08752e-01 1.12722e-01 4.81386e-02 0.00000e+00
2.51189e+01 1.08710e-01 1.12679e-01 4.81394e-02 0.00000e+00
@@ -123,8 +114,8 @@ 6.2. Details of each files
- 4th column:

-ex.) calculated results for fermion sample outputted as samles/fermion/find_lambda_opt.dat
.
-# log(x) diff log(y) log(f(x)) [all in log10 scale]
+ex.) calculated results for fermion sample outputted as samles/fermion/find_lambda_opt.dat
.
+# log(x) diff log(y) log(f(x)) [all in log10 scale]
2.00000e+00 1.92865e-16 -9.621340e-01 -9.621340e-01
1.80000e+00 -8.94525e-02 -9.631547e-01 -1.052607e+00
1.60000e+00 -1.79519e-01 -9.635618e-01 -1.143080e+00
@@ -140,8 +131,8 @@ 6.2. Details of each files (starting from 0)
- 2nd column: The singular value
in descending order
-ex.) calculated results for fermion sample outputted as samles/fermion/find_lambda_opt.dat
.
-0 1.07898e+02
+ex.) calculated results for fermion sample outputted as samles/fermion/find_lambda_opt.dat
.
+0 1.07898e+02
1 9.75830e+01
2 6.93652e+01
3 5.27590e+01
@@ -166,8 +157,8 @@ 6.2. Details of each files
- 10th column: negative weight in the spectrum

-ex.) calculated results for fermion sample outputted as samles/fermion/lambda_opt/iter.dat
.
-# iter diff(x,x_old) res1_pri res1_dual res2_pri res2_dual RMSE L1_norm sum(x) negative_weight
+ex.) calculated results for fermion sample outputted as samles/fermion/lambda_opt/iter.dat
.
+# iter diff(x,x_old) res1_pri res1_dual res2_pri res2_dual RMSE L1_norm sum(x) negative_weight
1 3.854841e-03 2.119714e-03 1.369725e-04 5.289078e-04 4.523259e-04 5.618012e-05 9.396320e-02 1.000546e+00 3.481495e-03
2 2.399056e-03 1.526513e-03 3.273800e-05 4.131063e-04 6.433491e-04 5.652371e-05 9.203257e-02 1.000546e+00 2.717878e-03
3 2.166172e-03 1.024876e-03 1.232067e-05 4.091785e-04 6.751225e-04 5.686296e-05 9.031303e-02 1.000546e+00 3.234967e-03
@@ -185,8 +176,8 @@ 6.2. Details of each files (must be sparse)
- 4th column:

-ex.) calculated results for fermion sample outputted as samles/fermion/lambda_opt/x_sv.dat
.
-0 -4.61300e-02 -4.61300e-02 -4.61492e-02
+ex.) calculated results for fermion sample outputted as samles/fermion/lambda_opt/x_sv.dat
.
+0 -4.61300e-02 -4.61300e-02 -4.61492e-02
1 1.14335e-06 0.00000e+00 -5.52982e-06
2 -6.65757e-03 -6.65757e-03 -6.69485e-03
3 -2.29934e-05 0.00000e+00 -1.16960e-05
@@ -204,8 +195,8 @@ 6.2. Details of each files (final result for a given lambda when non-negativity is not imposed)
- 4th column:
(final result for a given lambda when non-negativity is imposed)
-ex.) calculated results for fermion sample outputted as samles/fermion/lambda_opt/x_tw.dat
.
--4.00000e+00 8.98641e-04 3.95646e-03 0.00000e+00
+ex.) calculated results for fermion sample outputted as samles/fermion/lambda_opt/x_tw.dat
.
+-4.00000e+00 8.98641e-04 3.95646e-03 0.00000e+00
-3.99200e+00 8.73662e-04 3.79795e-03 0.00000e+00
-3.98400e+00 8.41470e-04 3.64070e-03 0.00000e+00
-3.97600e+00 8.02778e-04 3.48473e-03 0.00000e+00
@@ -223,8 +214,8 @@ 6.2. Details of each files
- 4th column:

-ex.) calculated results for fermion sample outputted as samles/fermion/lambda_opt/y_sv.dat
.
-0 -4.97866e+00 -4.97734e+00 -4.97734e+00
+ex.) calculated results for fermion sample outputted as samles/fermion/lambda_opt/y_sv.dat
.
+0 -4.97866e+00 -4.97734e+00 -4.97734e+00
1 1.16952e-04 1.11571e-04 0.00000e+00
2 -4.63728e-01 -4.61804e-01 -4.61804e-01
3 -1.28769e-03 -1.21311e-03 0.00000e+00
@@ -242,8 +233,8 @@ 6.2. Details of each files
- 4th column:

-ex.) calculated results for fermion sample outputted as samles/fermion/lambda_opt/y_tw.dat
.
-0.00000e+00 5.00734e-01 5.00687e-01 5.00294e-01
+ex.) calculated results for fermion sample outputted as samles/fermion/lambda_opt/y_tw.dat
.
+0.00000e+00 5.00734e-01 5.00687e-01 5.00294e-01
2.49938e-04 4.90130e-01 4.90315e-01 4.89958e-01
4.99875e-04 4.81350e-01 4.80277e-01 4.79953e-01
7.49813e-04 4.71476e-01 4.70561e-01 4.70268e-01
@@ -255,12 +246,12 @@ 6.2. Details of each filesoutput directory, type
-gnuplot path_to_SpM/samples/plt/*
+In the output
directory, type
+gnuplot path_to_SpM/samples/plt/*
-and in lambda_*
directory, type
-gnuplot path_to_SpM/samples/plt/lambda_fix/*
+and in lambda_*
directory, type
+gnuplot path_to_SpM/samples/plt/lambda_fix/*
@@ -311,12 +302,14 @@ Related Topics
@@ -327,7 +320,7 @@ Quick search
©2017, Junya Otsuki, Kazuyoshi Yoshimi, Hiroshi Shinaoka.
|
- Powered by Sphinx 1.6.5
+ Powered by Sphinx 1.7.1
& Alabaster 0.7.10
|
diff --git a/docs/manual/build/html/docs/tutorials.html b/docs/manual/build/html/docs/tutorials.html
index 4e33950..667c412 100644
--- a/docs/manual/build/html/docs/tutorials.html
+++ b/docs/manual/build/html/docs/tutorials.html
@@ -4,20 +4,12 @@
+
2. Tutorials — SpM 1.0.0 documentation
-
+
@@ -31,8 +23,7 @@
-
-
+
@@ -45,21 +36,21 @@
Sample data are provided both for fermionic and bosonic cases:
-samples/fermion
# a sample for fermionic spectrum (data in the article)
-samples/boson
# a sample for bosonic spectrum
+samples/fermion
# a sample for fermionic spectrum (data in the article)
+samples/boson
# a sample for bosonic spectrum
Here, an explanation is given for the fermionic case.
2.1. Script¶
-User can execute all the steps explained below using a single script file run.sh
.
+
User can execute all the steps explained below using a single script file run.sh
.
Edit some variables in the top of the script (explained later) and then run the script by
-$ ./run.sh
+$ ./run.sh
-If succeeded, text files containing numerical data and graphs in EPS format are generated in output
directory.
+
If succeeded, text files containing numerical data and graphs in EPS format are generated in output
directory.
There are some parameters to control the behavior of the script;
-# =========================
+# =========================
file_exe="../SpM.out"
dir_plt="../plt"
plot_level=1 # 0: no plot, 1: plot major data, 2: plot all data
@@ -75,8 +66,8 @@ 2.2. Make input filesGreen’s function
Input data for the imaginary time Green’s function
should be provided on a linearly discretized mesh between
and
.
-The file Gtau.in
contains sample data in the following manner
-#beta=100.000000
+The file Gtau.in
contains sample data in the following manner
+#beta=100.000000
#omega_max=4.000000
0.0 -0.500733991018 -0.499999977255
0.00025 -0.490129692246 -0.489780138726
@@ -93,16 +84,16 @@ 2.2. Make input files,
, and
.
-SpM
program actually reads only one column, in this case, the second column containing
.
-User is requested to specify with column
parameter which column should be read.
+SpM
program actually reads only one column, in this case, the second column containing
.
+User is requested to specify with column
parameter which column should be read.
Note that the value of
needs to be given in order to evaluate the integral intensity of
. It means that the integrated intensity is not necessarily be equal to 1 (0 for off-diagonal Green’s function and some finite value for the self energy).
Parameters
-Parameters are passed to the SpM
program by a text file.
-The file param.in
shows a setting used in obtaining the demonstrative results;
-# INPUT/OUTPUT
+Parameters are passed to the SpM
program by a text file.
+The file param.in
shows a setting used in obtaining the demonstrative results;
+# INPUT/OUTPUT
statistics="fermion"
beta=100
filein_G="Gtau.in"
@@ -127,47 +118,47 @@ 2.2. Make input files
2.3. Run SpM¶
-In the directory samples/fermion/
, just type the command
-$ build_directory/src/SpM.out -i param.in
+In the directory samples/fermion/
, just type the command
+$ build_directory/src/SpM.out -i param.in
2.4. Results¶
-Results are stored as ordinary text format in output
directory.
+
Results are stored as ordinary text format in output
directory.
See Output files for details of each file.
2.5. Plot¶
User can generate graphs either in EPS format or in PDF format using gnuplot.
-Move into directory output
, and type
-gnuplot path_to_SpM/samples/plt/*
+Move into directory output
, and type
+gnuplot path_to_SpM/samples/plt/*
-to generate EPS files of main results. If you prefer PDF format, put flag_pdf=1
option as
-gnuplot -e flag_pdf=1 path_to_SpM/samples/plt/*
+to generate EPS files of main results. If you prefer PDF format, put flag_pdf=1
option as
+gnuplot -e flag_pdf=1 path_to_SpM/samples/plt/*
-Note that it requires epstopdf
program in the PATH.
-Next, move into directory lambda_opt
and type
-gnuplot path_to_SpM/samples/plt/lambda_opt/*
+Note that it requires epstopdf
program in the PATH.
+Next, move into directory lambda_opt
and type
+gnuplot path_to_SpM/samples/plt/lambda_opt/*
Detailed results for the optimal value of
are then plotted.
-Again, the option flag_pdf=1
may be put to obtain PDF files.
+Again, the option flag_pdf=1
may be put to obtain PDF files.
Let us look at some graphs below.
spectrum.eps
-The final result for the spectrum
is given in the file output/spectrum.eps
.
+The final result for the spectrum
is given in the file output/spectrum.eps
.
-The red line shows the computed spectrum, and the blue line shows the exact spectrum, which is provided in the file Gtau.in.dos
(not output of the SpM
program).
+The red line shows the computed spectrum, and the blue line shows the exact spectrum, which is provided in the file Gtau.in.dos
(not output of the SpM
program).
find_lambda_opt.eps
-User should check how the regularization parameter
is determined and whether the choice is resonable.
-Loot at the file output/find_lambda_opt.eps
+User should check how the regularization parameter
is determined and whether the choice is reasonable.
+Loot at the file output/find_lambda_opt.eps
The peak position gives the optimal choice
.
If the peak is not clear, the choice might not be reasonable. In this case, accuracy of the input should be improved.
@@ -176,10 +167,10 @@ 2.5. Ploty_sv-log.eps
One can see how much information in the input data is used for constructing the spectrum.
-See the file output/lambda_opt/y_sv-log.eps
+See the file output/lambda_opt/y_sv-log.eps
The light blue points show the input data
transformed into the SVD basis, and red circles are data used in computing
above.
-The blue points show, for comparison, the exact
without noise, which is provided in the file Gtau.in.sv_basis
(not output of the SpM
program).
+The blue points show, for comparison, the exact
without noise, which is provided in the file Gtau.in.sv_basis
(not output of the SpM
program).
@@ -234,12 +225,14 @@ Related Topics
@@ -250,7 +243,7 @@ Quick search
©2017, Junya Otsuki, Kazuyoshi Yoshimi, Hiroshi Shinaoka.
|
- Powered by Sphinx 1.6.5
+ Powered by Sphinx 1.7.1
& Alabaster 0.7.10
|
diff --git a/docs/manual/build/html/genindex.html b/docs/manual/build/html/genindex.html
index c675522..5ebc0ac 100644
--- a/docs/manual/build/html/genindex.html
+++ b/docs/manual/build/html/genindex.html
@@ -5,20 +5,12 @@
+
Index — SpM 1.0.0 documentation
-
+
@@ -30,8 +22,7 @@
-
-
+
@@ -85,12 +76,14 @@ Related Topics
@@ -101,7 +94,7 @@ Quick search
©2017, Junya Otsuki, Kazuyoshi Yoshimi, Hiroshi Shinaoka.
|
- Powered by Sphinx 1.6.5
+ Powered by Sphinx 1.7.1
& Alabaster 0.7.10
diff --git a/docs/manual/build/html/index.html b/docs/manual/build/html/index.html
index 3b7b827..24ab72f 100644
--- a/docs/manual/build/html/index.html
+++ b/docs/manual/build/html/index.html
@@ -4,20 +4,12 @@
+
Welcome to SpM’s documentation! — SpM 1.0.0 documentation
-
+
@@ -30,8 +22,7 @@
-
-
+
@@ -41,7 +32,7 @@
Welcome to SpM’s documentation!¶
-This is a documantation of Sparse Modeling (SpM) tool for analytical continuation.
+This is a documentation of Sparse Modeling (SpM) tool for analytical continuation.
What is SpM ?¶
A sparse-modeling tool for computing the spectral function from the imaginary-time Green function. It removes statistical errors in quantum Monte Carlo data, and performs a stable analytical continuation. The obtained spectral function fulfills the non-negativity and the sum rule. The computation is fast and free from tuning parameters.
@@ -132,12 +123,14 @@ Related Topics
@@ -148,7 +141,7 @@ Quick search
©2017, Junya Otsuki, Kazuyoshi Yoshimi, Hiroshi Shinaoka.
|
- Powered by Sphinx 1.6.5
+ Powered by Sphinx 1.7.1
& Alabaster 0.7.10
|
diff --git a/docs/manual/build/html/search.html b/docs/manual/build/html/search.html
index 1eb9fb3..fab4caf 100644
--- a/docs/manual/build/html/search.html
+++ b/docs/manual/build/html/search.html
@@ -4,20 +4,12 @@
+
Search — SpM 1.0.0 documentation
-
+
@@ -37,8 +29,7 @@
-
-
+
@@ -114,7 +105,7 @@ Related Topics
©2017, Junya Otsuki, Kazuyoshi Yoshimi, Hiroshi Shinaoka.
|
- Powered by Sphinx 1.6.5
+ Powered by Sphinx 1.7.1
& Alabaster 0.7.10
diff --git a/docs/manual/build/html/searchindex.js b/docs/manual/build/html/searchindex.js
index 34ab4cc..3830cf5 100644
--- a/docs/manual/build/html/searchindex.js
+++ b/docs/manual/build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["docs/algorithm","docs/function","docs/inputfile","docs/install","docs/outputfile","docs/tutorials","index"],envversion:52,filenames:["docs/algorithm.rst","docs/function.rst","docs/inputfile.rst","docs/install.rst","docs/outputfile.rst","docs/tutorials.rst","index.rst"],objects:{},objnames:{},objtypes:{},terms:{"00000e":4,"000546e":4,"00294e":4,"00687e":4,"00734e":4,"00e":4,"024876e":4,"02778e":4,"031303e":4,"052607e":4,"07898e":4,"08609e":4,"08710e":4,"08752e":4,"08854e":4,"09110e":4,"091785e":4,"10th":4,"11571e":4,"119714e":4,"12578e":4,"12679e":4,"12722e":4,"12824e":4,"13080e":4,"131063e":4,"13754e":4,"143080e":4,"14335e":4,"14881e":4,"163075e":4,"166172e":4,"16677e":4,"16952e":4,"16960e":4,"198961e":4,"1st":4,"203257e":4,"21311e":4,"21754e":4,"232067e":4,"233554e":4,"234967e":4,"273800e":4,"27590e":4,"28769e":4,"289078e":4,"29934e":4,"2nd":4,"30957e":4,"33005e":4,"369725e":4,"396003e":4,"396320e":4,"399056e":4,"3rd":4,"40000e":4,"41470e":4,"425573e":4,"433491e":4,"450555e":4,"481495e":4,"48473e":4,"49813e":4,"49938e":4,"4th":4,"51189e":4,"523259e":4,"526513e":4,"52982e":4,"57046e":4,"58271e":4,"58489e":4,"585e":4,"58e":4,"5th":4,"60000e":4,"60890e":4,"61154e":4,"61300e":4,"61492e":4,"61762e":4,"618012e":4,"61804e":4,"621340e":4,"631547e":4,"635618e":4,"63728e":4,"637317e":4,"64070e":4,"652371e":4,"65757e":4,"686296e":4,"69485e":4,"69822e":4,"6th":4,"70268e":4,"70561e":4,"711656e":4,"71476e":4,"717878e":4,"73662e":4,"751225e":4,"75830e":4,"79519e":4,"79795e":4,"79953e":4,"7th":4,"80000e":4,"80277e":4,"81350e":4,"81361e":4,"81376e":4,"81386e":4,"81394e":4,"81459e":4,"854841e":4,"879910e":4,"89958e":4,"8th":4,"90130e":4,"90315e":4,"92865e":4,"93652e":4,"94525e":4,"95646e":4,"963409e":4,"96800e":4,"97600e":4,"97734e":4,"97866e":4,"98107e":4,"98400e":4,"98641e":4,"99200e":4,"99750e":4,"99875e":4,"9th":4,"break":0,"case":5,"default":2,"final":[4,5],"function":[1,2,4,5,6],"public":6,EPS:[3,5],For:[0,3,5],One:5,The:[0,1,2,3,4,5,6],There:5,abov:5,absolut:[2,3],accord:3,accuraci:[0,5],actual:5,admm:[1,2,5],after:[3,4],again:5,algorithm:6,all:[3,4,5],also:[],analyt:[0,6],ani:[0,3],approach:[0,6],archiv:3,articl:[0,5,6],ask:6,assum:3,automat:[0,2],auxiliari:4,basi:[4,5],becaus:0,becom:0,befor:5,begin:[4,5],behavior:5,below:[4,5],beta:[2,5],between:5,bla:3,blue:5,boson:[2,5],both:5,build:6,build_directori:5,calcul:[2,3,4,6],call:3,can:[3,5],carlo:[0,6],certain:0,chang:3,chapter:1,check:5,choic:5,choos:2,circl:5,cite:6,clear:5,clone:3,cmake:3,code:3,coeffici:2,column:[2,4,5],com:3,command:[3,5],comment:4,comparison:5,compil:3,comput:[4,5,6],concern:0,condit:[0,1],configur:3,constraint:[0,4],construct:5,contain:[4,5],continu:[0,6],control:5,convergi:2,correspond:5,cpp:1,cpplapack:3,creat:3,criteria:2,dat:[4,5],data:[0,3,4,5,6],decompress:3,defin:1,definit:0,demonstr:5,deriv:0,descend:4,descript:2,detail:[0,3,5,6],determin:[2,4,5],diagon:5,diff:4,dir_plt:5,directli:1,directori:[3,4,5],discret:5,distribut:6,documant:6,domain:4,done:[0,1,4],dos:5,doubl:2,download:6,dual:4,dure:2,each:[5,6],edit:5,either:5,empti:3,end:4,energi:5,engin:0,enter:3,environ:3,eps:5,eps_or_pdf:5,epstopdf:5,equal:5,equat:[0,1],error:[4,6],evalu:[0,5],even:0,exact:5,exampl:0,execut:[3,5],explain:5,explan:5,fast:6,fermion:[2,3,4,5],file:[3,6],file_ex:[3,5],filein_g:[2,5],fileout_spec:[2,5],find_lambda_opt:[4,5],finit:5,first:[3,4],fist:5,flag_pdf:5,flow:6,follow:[1,3,5],format:[3,5],four:4,free:6,frequenc:4,from:[0,3,4,6],fulfil:[0,6],further:5,g2spectrum:1,gener:[3,5,6],get:[1,3],getresult:1,getspectrum:1,git:3,github:3,give:5,given:[0,2,4,5],gnu:6,gnuplot:[4,5],gpl:6,graph:[3,5],green:[2,5,6],gtau:[1,2,5],hand:0,header:4,here:5,how:[5,6],http:3,ill:0,imaginari:[0,4,5,6],implement:1,impos:4,improv:5,includ:[3,6],index:4,indic:2,inform:[0,5],initi:1,input:[4,6],instal:6,integ:2,integr:5,intens:5,invers:[0,2],irrelev:0,iter:[2,4],its:2,just:[3,4,5],kernel:[1,4],kindli:6,l1_norm:4,lab:3,lambda:[2,4],lambda_1:4,lambda_:4,lambda_dep:4,lambda_fix:4,lambda_max:2,lambda_min:2,lambda_opt:[4,5],lambdalogbegin:[2,5],lambdalogend:[2,5],lambdalogmesh:2,lapack:3,later:5,latest:3,least:5,let:5,level:3,light:5,line:[4,5],linear:0,linearli:5,list:6,locat:3,log10:4,log:[2,4,5],look:5,loot:5,mai:[3,4,5],main:[1,5],major:5,make:[0,1,3,6],makefil:3,makekernellinear:1,manag:0,mandatori:2,manner:5,matrix:0,maximum:2,maxiter:[2,5],mean:5,mesh:[2,5],mesh_linear:1,mesh_log:1,method:[0,1],might:5,minim:4,minimum:2,mkdir:3,model:[0,6],moder:2,modifi:5,mont:[0,6],moor:0,more:4,move:[3,5],much:5,must:[0,4,5],name:2,nan:0,natur:0,necessari:3,necessarili:5,need:[3,5],neg:[2,4,6],negative_weight:4,next:5,nlambda:2,nois:[0,5],nomega:[2,5],non:[4,6],nonneg:0,norm:[0,4],note:[2,5],now:3,number:[2,4],numer:[0,4,5],obtain:[5,6],off:5,often:0,ohzeki:[0,6],omega:[2,4,5],omega_max:5,omegamax:[2,5],omegamin:[2,5],one:[0,5],onli:[2,5],optim:[2,4,5],option:[3,5],order:[4,5],ordinari:5,origin:[0,4],other:4,otsuki:[0,6],our:3,out:[2,3,5],output:[1,2,3,5,6],overview:6,packag:[3,6],param:[2,5],paramet:[0,1,2,3,5,6],particular:4,particularli:0,pass:5,path:[3,5],path_to_spm:[4,5],pdf:5,peak:5,penalti:2,penros:0,perform:6,phy:[0,6],physic:0,pleas:2,plot:6,plot_level:5,plt:[4,5],point:5,posit:5,pramet:2,precondit:0,prefer:5,primari:4,printlevel:2,problem:4,problemat:0,procedur:6,process:0,program:[0,3,5],provid:[0,3,5],pseudo:0,put:5,quantiti:4,quantum:[0,6],quit:0,read:[1,5],read_gtau:1,readparam:1,real:4,reason:5,red:5,ref:4,regular:[0,5],rel:3,releas:3,relev:0,remov:6,repositori:3,request:5,requir:[5,6],res1_dual:4,res1_pri:4,res2_dual:4,res2_pri:4,residu:4,reson:5,respect:0,result:[0,1,3,4,6],rev:[0,6],rho:4,rmse:4,rule:[0,6],run:[3,6],same:3,saml:4,sampl:[3,4,5],satisfi:0,scale:4,script:[3,4,6],second:[4,5],see:[0,3,4,5],self:5,sensit:0,separ:[0,4],set:[1,5],set_initi:1,setflag:1,setparamet:1,sever:4,shinaoka:[0,6],should:[4,5],show:5,shown:1,simpl:0,singl:5,singlular:2,singular:4,skip:5,small:4,solut:[0,4],solv:[0,1],solveequ:1,some:[3,4,5],sourc:3,space:4,spars:[0,4,6],specif:4,specifi:5,spectra:0,spectral:6,spectrum:[0,2,4,5],spm:[0,1,2,3],spm_core:1,squar:4,src:[3,5],stabl:[3,6],start:[2,4],statist:[2,5,6],step:[2,5],store:[2,4,5],string:2,succeed:[3,5],sum:[0,4,6],summar:4,sv_basi:5,svd:[2,5],svmin:2,system:3,tar:3,tau:2,techniqu:0,temperatur:2,term:4,test:6,text:5,thi:[0,1,3,4,5,6],through:[],time:[0,4,5,6],toler:[2,5],tool:6,top:5,transform:[4,5],treatment:0,truncat:2,tune:[0,6],tutori:[3,6],two:[],type:[2,4,5],under:6,unphys:0,unstabl:0,updat:1,used:[2,4,5],user:5,uses:0,using:[0,5,6],valu:[2,4,5],variabl:[2,5],verbos:2,version:[3,6],weight:4,when:[0,4],where:2,whether:5,which:[0,2,5],white:4,within:0,without:[0,5],x_old:4,x_sv:4,x_tw:4,y_sv:[4,5],y_tw:4,yoshimi:[0,6],you:[3,5,6],your:3,zxvf:3},titles:["3. Algorithm","4. Calculation flow","5. Input files","1. How to install","6. Output files","2. Tutorials","Welcome to SpM\u2019s documentation!"],titleterms:{algorithm:0,build:3,calcul:1,content:6,detail:4,document:6,download:3,each:4,file:[2,4,5],flow:1,gener:[],how:3,input:[2,5],instal:3,licens:6,list:4,make:5,model:1,output:4,overview:1,pdf:[],plot:5,procedur:1,requir:3,result:5,run:5,sampl:[],script:5,spars:1,spm:[5,6],test:3,tutori:5,welcom:6,what:6}})
\ No newline at end of file
+Search.setIndex({docnames:["docs/algorithm","docs/function","docs/inputfile","docs/install","docs/outputfile","docs/tutorials","index"],envversion:53,filenames:["docs/algorithm.rst","docs/function.rst","docs/inputfile.rst","docs/install.rst","docs/outputfile.rst","docs/tutorials.rst","index.rst"],objects:{},objnames:{},objtypes:{},terms:{"00000e":4,"000546e":4,"00294e":4,"00687e":4,"00734e":4,"00e":4,"024876e":4,"02778e":4,"031303e":4,"052607e":4,"07898e":4,"08609e":4,"08710e":4,"08752e":4,"08854e":4,"09110e":4,"091785e":4,"10th":4,"11571e":4,"119714e":4,"12578e":4,"12679e":4,"12722e":4,"12824e":4,"13080e":4,"131063e":4,"13754e":4,"143080e":4,"14335e":4,"14881e":4,"163075e":4,"166172e":4,"16677e":4,"16952e":4,"16960e":4,"198961e":4,"1st":4,"203257e":4,"21311e":4,"21754e":4,"232067e":4,"233554e":4,"234967e":4,"273800e":4,"27590e":4,"28769e":4,"289078e":4,"29934e":4,"2nd":4,"30957e":4,"33005e":4,"369725e":4,"396003e":4,"396320e":4,"399056e":4,"3rd":4,"40000e":4,"41470e":4,"425573e":4,"433491e":4,"450555e":4,"481495e":4,"48473e":4,"49813e":4,"49938e":4,"4th":4,"51189e":4,"523259e":4,"526513e":4,"52982e":4,"57046e":4,"58271e":4,"58489e":4,"585e":4,"58e":4,"5th":4,"60000e":4,"60890e":4,"61154e":4,"61300e":4,"61492e":4,"61762e":4,"618012e":4,"61804e":4,"621340e":4,"631547e":4,"635618e":4,"63728e":4,"637317e":4,"64070e":4,"652371e":4,"65757e":4,"686296e":4,"69485e":4,"69822e":4,"6th":4,"70268e":4,"70561e":4,"711656e":4,"71476e":4,"717878e":4,"73662e":4,"751225e":4,"75830e":4,"79519e":4,"79795e":4,"79953e":4,"7th":4,"80000e":4,"80277e":4,"81350e":4,"81361e":4,"81376e":4,"81386e":4,"81394e":4,"81459e":4,"854841e":4,"879910e":4,"89958e":4,"8th":4,"90130e":4,"90315e":4,"92865e":4,"93652e":4,"94525e":4,"95646e":4,"963409e":4,"96800e":4,"97600e":4,"97734e":4,"97866e":4,"98107e":4,"98400e":4,"98641e":4,"99200e":4,"99750e":4,"99875e":4,"9th":4,"break":0,"case":5,"default":2,"final":[4,5],"function":[1,2,4,5,6],"public":6,EPS:[3,5],For:[0,3,5],One:5,The:[0,1,2,3,4,5,6],There:5,abov:5,absolut:[2,3],accord:3,accuraci:[0,5],actual:5,admm:[1,2,5],after:[3,4],again:5,algorithm:6,all:[3,4,5],analyt:[0,6],ani:[0,3],approach:[0,6],archiv:3,articl:[0,5,6],ask:6,assum:3,automat:[0,2],auxiliari:4,basi:[4,5],becaus:0,becom:0,befor:5,begin:[4,5],behavior:5,below:[4,5],beta:[2,5],between:5,bla:3,blue:5,boson:[2,5],both:5,build:6,build_directori:5,calcul:[2,3,4,6],call:3,can:[3,5],carlo:[0,6],certain:0,chang:3,chapter:1,check:5,choic:5,choos:2,circl:5,cite:6,clear:5,clone:3,cmake:3,code:3,coeffici:2,column:[2,4,5],com:3,command:[3,5],comment:4,comparison:5,compil:3,comput:[4,5,6],concern:0,condit:[0,1],configur:3,constraint:[0,4],construct:5,contain:[4,5],continu:[0,6],control:5,converg:2,correspond:5,cpp:1,cpplapack:3,creat:3,criteria:2,dat:[4,5],data:[0,3,4,5,6],decompress:3,defin:1,definit:0,demonstr:5,deriv:0,descend:4,descript:2,detail:[0,3,5,6],determin:[2,4,5],diagon:5,diff:4,dir_plt:5,directli:1,directori:[3,4,5],discret:5,distribut:6,documant:[],domain:4,done:[0,1,4],dos:5,doubl:2,download:6,dual:4,dure:2,each:[5,6],edit:5,either:5,empti:3,end:4,energi:5,engin:0,enter:3,environ:3,eps:5,eps_or_pdf:5,epstopdf:5,equal:5,equat:[0,1],error:[4,6],evalu:[0,5],even:0,exact:5,exampl:0,execut:[3,5],explain:5,explan:5,fast:6,fermion:[2,3,4,5],file:[3,6],file_ex:[3,5],filein_g:[2,5],fileout_spec:[2,5],find_lambda_opt:[4,5],finit:5,first:[3,4],fist:5,flag_pdf:5,flow:6,follow:[1,3,5],format:[3,5],four:4,free:6,frequenc:4,from:[0,3,4,6],fulfil:[0,6],further:5,g2spectrum:1,gener:[3,5,6],get:[1,3],getresult:1,getspectrum:1,git:3,github:3,give:5,given:[0,2,4,5],gnu:6,gnuplot:[4,5],gpl:6,graph:[3,5],green:[2,5,6],gtau:[1,2,5],hand:0,header:4,here:5,how:[5,6],http:3,ill:0,imaginari:[0,4,5,6],implement:1,impos:4,improv:5,includ:[3,6],index:4,indic:2,inform:[0,5],initi:1,input:[4,6],instal:6,integ:2,integr:5,intens:5,invers:[0,2],irrelev:0,iter:[2,4],its:2,just:[3,4,5],kernel:[1,4],kindli:6,l1_norm:4,lab:3,lambda:[2,4],lambda_1:4,lambda_:4,lambda_dep:4,lambda_fix:4,lambda_max:2,lambda_min:2,lambda_opt:[4,5],lambdalogbegin:[2,5],lambdalogend:[2,5],lambdalogmesh:2,lapack:3,later:5,latest:3,least:5,let:5,level:3,light:5,line:[4,5],linear:0,linearli:5,list:6,locat:3,log10:4,log:[2,4,5],look:5,loot:5,mai:[3,4,5],main:[1,5],major:5,make:[0,1,3,6],makefil:3,makekernellinear:1,manag:0,mandatori:2,manner:5,matrix:0,maximum:2,maxiter:[2,5],mean:5,mesh:[2,5],mesh_linear:1,mesh_log:1,method:[0,1],might:5,minim:4,minimum:2,mkdir:3,model:[0,6],moder:2,modifi:5,mont:[0,6],moor:0,more:4,move:[3,5],much:5,must:[0,4,5],name:2,nan:0,natur:0,necessari:3,necessarili:5,need:[3,5],neg:[2,4,6],negative_weight:4,next:5,nlambda:2,nois:[0,5],nomega:[2,5],non:[4,6],nonneg:0,norm:[0,4],note:[2,5],now:3,number:[2,4],numer:[0,4,5],obtain:[5,6],off:5,often:0,ohzeki:[0,6],omega:[2,4,5],omega_max:5,omegamax:[2,5],omegamin:[2,5],one:[0,5],onli:[2,5],optim:[2,4,5],option:[3,5],order:[4,5],ordinari:5,origin:[0,4],other:4,otsuki:[0,6],our:3,out:[2,3,5],output:[1,2,3,5,6],overview:6,packag:[3,6],param:[2,5],paramet:[0,1,2,3,5,6],particular:4,particularli:0,pass:5,path:[3,5],path_to_spm:[4,5],pdf:5,peak:5,penalti:2,penros:0,perform:6,phy:[0,6],physic:0,pleas:2,plot:6,plot_level:5,plt:[4,5],point:5,posit:5,precondit:0,prefer:5,primari:4,printlevel:2,problem:4,problemat:0,procedur:6,process:0,program:[0,3,5],provid:[0,3,5],pseudo:0,put:5,quantiti:4,quantum:[0,6],quit:0,read:[1,5],read_gtau:1,readparam:1,real:4,reason:5,red:5,ref:4,regular:[0,5],rel:3,releas:3,relev:0,remov:6,repositori:3,request:5,requir:[5,6],res1_dual:4,res1_pri:4,res2_dual:4,res2_pri:4,residu:4,respect:0,result:[0,1,3,4,6],rev:[0,6],rho:4,rmse:4,rule:[0,6],run:[3,6],same:3,saml:4,sampl:[3,4,5],satisfi:0,scale:4,script:[3,4,6],second:[4,5],see:[0,3,4,5],self:5,sensit:0,separ:[0,4],set:[1,5],set_initi:1,setflag:1,setparamet:1,sever:4,shinaoka:[0,6],should:[4,5],show:5,shown:1,simpl:0,singiular:[],singl:5,singular:[2,4],skip:5,small:4,solut:[0,4],solv:[0,1],solveequ:1,some:[3,4,5],sourc:3,space:4,spars:[0,4,6],specif:4,specifi:5,spectra:0,spectral:6,spectrum:[0,2,4,5],spm:[0,1,2,3],spm_core:1,squar:4,src:[3,5],stabl:[3,6],start:[2,4],statist:[2,5,6],step:[2,5],store:[2,4,5],string:2,succeed:[3,5],sum:[0,4,6],summar:4,sv_basi:5,svd:[2,5],svmin:2,system:3,tar:3,tau:2,techniqu:0,temperatur:2,term:4,test:6,text:5,thi:[0,1,3,4,5,6],time:[0,4,5,6],toler:[2,5],tool:6,top:5,transform:[4,5],treatment:0,truncat:2,tune:[0,6],tutori:[3,6],type:[2,4,5],under:6,unphys:0,unstabl:0,updat:1,used:[2,4,5],user:5,uses:0,using:[0,5,6],valu:[2,4,5],variabl:[2,5],verbos:2,version:[3,6],weight:4,when:[0,4],where:2,whether:5,which:[0,2,5],white:4,within:0,without:[0,5],x_old:4,x_sv:4,x_tw:4,y_sv:[4,5],y_tw:4,yoshimi:[0,6],you:[3,5,6],your:3,zxvf:3},titles:["3. Algorithm","4. Calculation flow","5. Input files","1. How to install","6. Output files","2. Tutorials","Welcome to SpM\u2019s documentation!"],titleterms:{algorithm:0,build:3,calcul:1,content:6,detail:4,document:6,download:3,each:4,file:[2,4,5],flow:1,how:3,input:[2,5],instal:3,licens:6,list:4,make:5,model:1,output:4,overview:1,plot:5,procedur:1,requir:3,result:5,run:5,script:5,spars:1,spm:[5,6],test:3,tutori:5,welcom:6,what:6}})
\ No newline at end of file
diff --git a/docs/manual/source/Makefile b/docs/manual/source/Makefile
index da07f37..5b68aba 100644
--- a/docs/manual/source/Makefile
+++ b/docs/manual/source/Makefile
@@ -52,6 +52,7 @@ clean:
.PHONY: html
html:
+ $(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
diff --git a/docs/manual/source/conf.py b/docs/manual/source/conf.py
index 65b5128..64c04ef 100644
--- a/docs/manual/source/conf.py
+++ b/docs/manual/source/conf.py
@@ -37,7 +37,9 @@
'sphinxcontrib.actdiag',
'sphinxcontrib.nwdiag',
'sphinxcontrib.rackdiag',
- 'sphinxcontrib.packetdiag',]
+ 'sphinxcontrib.packetdiag',
+ 'sphinxcontrib.spelling',]
+
#mathjax_path = 'http://mathjax.connectmv.com/MathJax.js?config=default'
blockdiag_html_image_format = 'SVG'
diff --git a/docs/manual/source/docs/inputfile.rst b/docs/manual/source/docs/inputfile.rst
index dacad7f..ff56082 100644
--- a/docs/manual/source/docs/inputfile.rst
+++ b/docs/manual/source/docs/inputfile.rst
@@ -7,7 +7,7 @@
Input files
===============================
-1. Paramete file (param.in)
+1. Parameter file (param.in)
The variables for which default value is not given are mandatory.
@@ -47,7 +47,7 @@ The variables for which default value is not given are mandatory.
:widths: 1,1,2,4
Name, Type, Default value, Description
- SVmin, Double, 1e-10, Truncation value of singlular values.
+ SVmin, Double, 1e-10, Truncation value of singular values.
* ADMM
@@ -62,7 +62,7 @@ The variables for which default value is not given are mandatory.
lambdalogend, Double, -1, The log value of minimum lambda. lambda_min is given by :math:`10^{\verb|lambdalogend|}`
Nlambda, Integer, ---, The number of lambda to be calculated.
penalty, Double, 10.0, "The value of penalty coefficient. If negative, penalty is optimized during the iteration starting with its absolute value."
- tolerance, Double, 1e-6, The criteria of convergience.
+ tolerance, Double, 1e-6, The criteria of convergence.
maxiteration, Integer,1000, The maximum number of iterations.
printlevel, Integer,2, "0; minimum, 1; moderate, 2; verbose."
@@ -71,4 +71,4 @@ The variables for which default value is not given are mandatory.
In SPM, the values of Green's function is only used for calculation,
i.e. tau is automatically determined by the beta and the step.
Please indicate the column number where the values of G(tau) are
- stored by "column" in the prameter file.
+ stored by "column" in the parameter file.
diff --git a/docs/manual/source/docs/tutorials.rst b/docs/manual/source/docs/tutorials.rst
index b00f659..0bcfb13 100644
--- a/docs/manual/source/docs/tutorials.rst
+++ b/docs/manual/source/docs/tutorials.rst
@@ -150,7 +150,7 @@ Let us look at some graphs below.
- *find_lambda_opt.eps*
- User should check how the regularization parameter :math:`\lambda` is determined and whether the choice is resonable.
+ User should check how the regularization parameter :math:`\lambda` is determined and whether the choice is reasonable.
Loot at the file ``output/find_lambda_opt.eps``
.. image:: figs/find_lambda_opt.jpg
diff --git a/docs/manual/source/index.rst b/docs/manual/source/index.rst
index 0021e8f..590459d 100644
--- a/docs/manual/source/index.rst
+++ b/docs/manual/source/index.rst
@@ -5,7 +5,7 @@
Welcome to SpM's documentation!
===============================
-This is a documantation of Sparse Modeling (SpM) tool for analytical continuation.
+This is a documentation of Sparse Modeling (SpM) tool for analytical continuation.
What is SpM ?
-------------
diff --git a/docs/manual/source/spelling_wordlist.txt b/docs/manual/source/spelling_wordlist.txt
new file mode 100644
index 0000000..2f0bb57
--- /dev/null
+++ b/docs/manual/source/spelling_wordlist.txt
@@ -0,0 +1,33 @@
+Yoshimi
+SVmin
+spm
+SpM
+Shinaoka
+printlevel
+param
+Otsuki
+omegamin
+omegamax
+Ohzeki
+nonnegativity
+NOmega
+Nomega
+Nlambda
+nd
+NaN
+maxiteration
+lambdalogmesh
+lambdalogend
+lambdalogbegin
+Gtau
+Gnuplot
+gnuplot
+fileout
+filein
+fermionic
+dep
+dat
+cpplapack
+cpp
+cmake
+bosonic