Skip to content

Commit

Permalink
Merge pull request #131 from issp-center-dev/release
Browse files Browse the repository at this point in the history
Release
  • Loading branch information
k-yoshimi authored Jun 14, 2022
2 parents 56382ed + 139ea8d commit a1e6571
Show file tree
Hide file tree
Showing 54 changed files with 459 additions and 283 deletions.
2 changes: 1 addition & 1 deletion doc/en/locale/de/LC_MESSAGES/filespecification.po
Original file line number Diff line number Diff line change
Expand Up @@ -1280,7 +1280,7 @@ msgid ""
"**Description :** If CalcHS=1, an efficient algorithm for generating the "
"restricted Hilbert space with the specified quantum number is used "
"(Details of algorithm is shown in "
"http://qlms.github.io/HPhi/develop/tips.pdf [in Japanese]). Default value"
"https://www.pasums.issp.u-tokyo.ac.jp/wp-content/themes/HPhi/media/develop/tips.pdf [in Japanese]). Default value"
" is 1 and the efficient algorithm is used."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion doc/en/locale/de/LC_MESSAGES/howtouse.po
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ msgid "You can download :math:`{\\mathcal H}\\Phi` at the following location."
msgstr ""

#: ../../howtouse/installation_en.rst:6
msgid "https://github.com/QLMS/HPhi/releases"
msgid "https://github.com/issp-center-dev/HPhi/releases"
msgstr ""

#: ../../howtouse/installation_en.rst:8
Expand Down
4 changes: 2 additions & 2 deletions doc/en/locale/de/LC_MESSAGES/index.po
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ msgstr ""
#: ../../index.rst:30
msgid ""
"You can download software and source codes of :math:`{\\mathcal H}\\Phi` "
"from `GitHub page <https://github.com/QLMS/HPhi>`_ or `release page "
"<https://github.com/QLMS/HPhi/releases>`_."
"from `GitHub page <https://github.com/issp-center-dev/HPhi>`_ or `release page "
"<https://github.com/issp-center-dev/HPhi/releases>`_."
msgstr ""

#: ../../index.rst:34
Expand Down
2 changes: 1 addition & 1 deletion doc/en/locale/ja/LC_MESSAGES/filespecification.po
Original file line number Diff line number Diff line change
Expand Up @@ -1280,7 +1280,7 @@ msgid ""
"**Description :** If CalcHS=1, an efficient algorithm for generating the "
"restricted Hilbert space with the specified quantum number is used "
"(Details of algorithm is shown in "
"http://qlms.github.io/HPhi/develop/tips.pdf [in Japanese]). Default value"
"https://www.pasums.issp.u-tokyo.ac.jp/wp-content/themes/HPhi/media/develop/tips.pdf [in Japanese]). Default value"
" is 1 and the efficient algorithm is used."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion doc/en/locale/ja/LC_MESSAGES/howtouse.po
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ msgid "You can download :math:`{\\mathcal H}\\Phi` at the following location."
msgstr ""

#: ../../howtouse/installation_en.rst:6
msgid "https://github.com/QLMS/HPhi/releases"
msgid "https://github.com/issp-center-dev/HPhi/releases"
msgstr ""

#: ../../howtouse/installation_en.rst:8
Expand Down
4 changes: 2 additions & 2 deletions doc/en/locale/ja/LC_MESSAGES/index.po
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ msgstr ""
#: ../../index.rst:30
msgid ""
"You can download software and source codes of :math:`{\\mathcal H}\\Phi` "
"from `GitHub page <https://github.com/QLMS/HPhi>`_ or `release page "
"<https://github.com/QLMS/HPhi/releases>`_."
"from `GitHub page <https://github.com/issp-center-dev/HPhi>`_ or `release page "
"<https://github.com/issp-center-dev/HPhi/releases>`_."
msgstr ""

#: ../../index.rst:34
Expand Down
8 changes: 4 additions & 4 deletions doc/en/source/algorithm/Lanczos_en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,8 @@ Details of implementation
For the Lanczos method, an initial vector is specified with ``initial_iv``:math:`(\equiv r_s)` defined in an input file for Standard mode or a ModPara file for Expert mode. The type of initial vector can be selected as a real number or complex number by using ``InitialVecType`` in a ModPara file.


* For canonical ensemble and ``initial_iv``:math:`\geq 0`
A component of a target of the Hilbert space is given by
* For canonical ensemble and ``initial_iv``:math:`\geq 0`,
a component of a target of the Hilbert space is given by

.. math::
Expand All @@ -157,8 +157,8 @@ For the Lanczos method, an initial vector is specified with ``initial_iv``:math:
where :math:`N_{\rm dim}` is the total number of the Hilbert spaces and :math:`N_{\rm dim}/2` is added to avoid selecting a special Hilbert space for a default value ``initial_iv`` :math:`=1`.
When the type of initial vector is selected as a real number, the coefficient value is given by :math:`1`, while when it is selected as a complex number, the value is given by :math:`(1+i)/\sqrt{2}`.

* For a grand canonical ensemble or ``initial_iv`` :math:`<0`
The initial vector is given by using a random generator, i.e., the coefficients of all the components for the initial vector are given by random numbers. The seed is calculated as
* For a grand canonical ensemble or ``initial_iv`` :math:`<0`,
the initial vector is given by using a random generator, i.e., the coefficients of all the components for the initial vector are given by random numbers. The seed is calculated as

.. math::
Expand Down
6 changes: 3 additions & 3 deletions doc/en/source/algorithm/Realtime_en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ In :math:`{\mathcal H}\Phi`, real time evolution calculation is done by using th

.. math::
|\Phi (t_n)\rangle = \exp^{-i {\cal H} \Delta t_n}|\Phi (t_{n-1})\rangle,
|\Phi (t_n)\rangle = \exp (-i {\cal H} \Delta t_n)|\Phi (t_{n-1})\rangle,
where :math:`|\Phi(t_0)\rangle` is an initial wave function and :math:`t_n = \sum_{j=1}^n \Delta t_j`.
In calculation, we approximate :math:`\exp^{-i {\cal H} \Delta t_n}` as
In calculation, we approximate :math:`\exp (-i {\cal H} \Delta t_n)` as

.. math::
\exp^{-i {\cal H} \Delta t_n} =\sum_{l=0}^m \frac{1}{l!}(-i {\cal H} \Delta t_n)^l .
\exp (-i {\cal H} \Delta t_n) =\sum_{l=0}^m \frac{1}{l!}(-i {\cal H} \Delta t_n)^l .
Here, the cut-off integer :math:`m` can be set by `ExpandCoef` in `ModPara`.
We can judge whether the expansion order is enough or not by checking the norm conservation :math:`\langle \Phi (t_n)|\Phi (t_n)\rangle=1` and energy conservation :math:`\langle \Phi (t_n)|\hat{\cal H}|\Phi (t_n)\rangle=E`.
3 changes: 2 additions & 1 deletion doc/en/source/algorithm/TPQ_en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ For the TPQ method, the initial vector is given by using a random generator, i.e
123432+(n_{\rm run}+1)\times|r_s|+k_{\rm Thread}+N_{\rm Thread} \times k_{\rm Process},
where :math:`r_s` is the number given by an input file and :math:`n_{\rm run}` is the number of runs. :math:`r_s` and the maximum value of :math:`n_{\rm run}` are defined by ``initial_iv`` and ``NumAve`` in an input file for Standard mode or a ModPara file for Expert mode, respectively. Random numbers are generated by using SIMD-oriented Fast Mersenne Twister (dSFMT) [3]_ . We can select the type of initial vector as a real number or complex number by using ``InitialVecType`` in a ModPara file.
:math:`k_{\rm Thread}, N_{\rm Thread}, and k_{\rm Process}` indicate
:math:`k_{\rm Thread}, N_{\rm Thread},`
and :math:`k_{\rm Process}` indicate
the thread ID, number of threads, process ID, respectively;
the initial vector depends both on ``initial_iv`` and the number of parallelisms.

Expand Down
2 changes: 1 addition & 1 deletion doc/en/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@

# General information about the project.
project = u'HΦ Documentation'
copyright = u'2021, The University of Tokyo'
copyright = u'2022, The University of Tokyo'
author = u'The University of Tokyo'

# The version info for the project you're documenting, acts as replacement for
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ integrals :math:`I_{ijkl\sigma_1\sigma_2\sigma_3\sigma_4}`,
{\mathcal H}+=\sum_{i,j,k,l}\sum_{\sigma_1,\sigma_2, \sigma_3, \sigma_4}
I_{ijkl\sigma_1\sigma_2\sigma_3\sigma_4}c_{i\sigma_1}^{\dagger}c_{j\sigma_2}c_{k\sigma_3}^{\dagger}c_{l\sigma_4}.
For spin, the conditions :math:`i=j` and :math:`k=l` must be satisfied. An example of the file format is as follows.
For the off-diagonal component, be sure to provide a pair of i1 sigma1 i2 sigma2 i3 sigma3 i4 sigma4 and i4 sigma4 i3 sigma3 i2 sigma2 i1 sigma1.
For spin, the conditions :math:`i=j` and :math:`k=l` must be satisfied.
An example of the file format is as follows.

::

Expand Down Expand Up @@ -138,4 +140,4 @@ Use rules

.. raw:: latex

\newpage
\newpage
4 changes: 3 additions & 1 deletion doc/en/source/howtouse/directorystructure_en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ When HPhi-xxx.tar.gz is unzipped, the following directory structure is composed.
|--doc/
| |--en/
| |--ja/
| |--fourier/
| |--tutorial/
| |--tutorial_HPhi_en.pdf
| |--userguide_en.pdf
| |--userguide_jp.pdf
|--README.md
|--samples/
|--src/
| |--*.c
Expand Down
12 changes: 1 addition & 11 deletions doc/en/source/howtouse/installation_en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,13 @@ Installation

You can download :math:`{\mathcal H}\Phi` at the following location.

https://github.com/QLMS/HPhi/releases
https://github.com/issp-center-dev/HPhi/releases

You can obtain the :math:`{\mathcal H}\Phi` directory by typing

``$ tar xzvf HPhi-xxx.tar.gz``

:math:`{\mathcal H}\Phi` can be installed by using cmake.

.. tip::

| Before using cmake for sekirei, you must type
| ``module load cmake``
| :math:`{\mathcal H}\Phi` has been preinstalled on ISSP supercomputers.
| If you want to use this preinstalled version, please type
| ``source /home/issp/materiapps/hphi/hphivars.sh``
.. | ``source /home/issp/materiapps/tool/env.sh``
We can compile :math:`{\mathcal H}\Phi` as::

cd $HOME/build/hphi
Expand Down
2 changes: 1 addition & 1 deletion doc/en/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This software was developed with the support of \"*Project for advancement of so

Download
--------
You can download software and source codes of :math:`{\mathcal H}\Phi` from `GitHub page <https://github.com/QLMS/HPhi>`_ or `release page <https://github.com/QLMS/HPhi/releases>`_.
You can download software and source codes of :math:`{\mathcal H}\Phi` from `GitHub page <https://github.com/issp-center-dev/HPhi>`_ or `release page <https://github.com/issp-center-dev/HPhi/releases>`_.


Contents
Expand Down
7 changes: 5 additions & 2 deletions doc/en/source/introduction_en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ Contributors

This software was developed by the following contributors.

* ver.3.5.1 (released on 2022/6/14)

* ver.3.5 (released on 2021/9/29)

* ver.3.4 (released on 2020/6/2)

* Developers
Expand Down Expand Up @@ -114,8 +118,7 @@ Operating environment

:math:`{\mathcal H}\Phi` was tested on the following platforms

* The supercomputer system-B \"sekirei\" and system-C \"enaga\" in ISSP
* Fujitsu FX-10
* The supercomputer system-B \"ohtaka\" in ISSP
* Linux PC + Intel compiler
* Linux PC + GCC.
* Mac + GCC.
Expand Down
8 changes: 1 addition & 7 deletions doc/en/source/tutorial/fourier_en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,5 @@
Fourier transformation of correlation functions
===============================================

This package has a utility which performs the Fourier transformation of the correlation function and plots that function.
The manual of this utility is located in ::

doc/fourier/ja/_build/html/index.html
doc/fourier/ja/_build/latex/fourier.pdf
doc/fourier/en/_build/html/index.html
doc/fourier/en/_build/latex/fourier.pdf
This package has a utility which performs the Fourier transformation of the correlation function and plots that function. For details, see Appendix A.

2 changes: 1 addition & 1 deletion doc/ja/locale/de/LC_MESSAGES/filespecification.po
Original file line number Diff line number Diff line change
Expand Up @@ -1280,7 +1280,7 @@ msgid ""
"**Description :** If CalcHS=1, an efficient algorithm for generating the "
"restricted Hilbert space with the specified quantum number is used "
"(Details of algorithm is shown in "
"http://qlms.github.io/HPhi/develop/tips.pdf [in Japanese]). Default value"
"https://www.pasums.issp.u-tokyo.ac.jp/wp-content/themes/HPhi/media/develop/tips.pdf [in Japanese]). Default value"
" is 1 and the efficient algorithm is used."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion doc/ja/locale/de/LC_MESSAGES/howtouse.po
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ msgid "You can download :math:`{\\mathcal H}\\Phi` at the following location."
msgstr ""

#: ../../howtouse/installation_en.rst:6
msgid "https://github.com/QLMS/HPhi/releases"
msgid "https://github.com/issp-center-dev/HPhi/releases"
msgstr ""

#: ../../howtouse/installation_en.rst:8
Expand Down
4 changes: 2 additions & 2 deletions doc/ja/locale/de/LC_MESSAGES/index.po
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ msgstr ""
#: ../../index.rst:30
msgid ""
"You can download software and source codes of :math:`{\\mathcal H}\\Phi` "
"from `GitHub page <https://github.com/QLMS/HPhi>`_ or `release page "
"<https://github.com/QLMS/HPhi/releases>`_."
"from `GitHub page <https://github.com/issp-center-dev/HPhi>`_ or `release page "
"<https://github.com/issp-center-dev/HPhi/releases>`_."
msgstr ""

#: ../../index.rst:34
Expand Down
2 changes: 1 addition & 1 deletion doc/ja/locale/ja/LC_MESSAGES/filespecification.po
Original file line number Diff line number Diff line change
Expand Up @@ -1280,7 +1280,7 @@ msgid ""
"**Description :** If CalcHS=1, an efficient algorithm for generating the "
"restricted Hilbert space with the specified quantum number is used "
"(Details of algorithm is shown in "
"http://qlms.github.io/HPhi/develop/tips.pdf [in Japanese]). Default value"
"https://www.pasums.issp.u-tokyo.ac.jp/wp-content/themes/HPhi/media/develop/tips.pdf [in Japanese]). Default value"
" is 1 and the efficient algorithm is used."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion doc/ja/locale/ja/LC_MESSAGES/howtouse.po
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ msgid "You can download :math:`{\\mathcal H}\\Phi` at the following location."
msgstr ""

#: ../../howtouse/installation_en.rst:6
msgid "https://github.com/QLMS/HPhi/releases"
msgid "https://github.com/issp-center-dev/HPhi/releases"
msgstr ""

#: ../../howtouse/installation_en.rst:8
Expand Down
4 changes: 2 additions & 2 deletions doc/ja/locale/ja/LC_MESSAGES/index.po
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ msgstr ""
#: ../../index.rst:30
msgid ""
"You can download software and source codes of :math:`{\\mathcal H}\\Phi` "
"from `GitHub page <https://github.com/QLMS/HPhi>`_ or `release page "
"<https://github.com/QLMS/HPhi/releases>`_."
"from `GitHub page <https://github.com/issp-center-dev/HPhi>`_ or `release page "
"<https://github.com/issp-center-dev/HPhi/releases>`_."
msgstr ""

#: ../../index.rst:34
Expand Down
2 changes: 1 addition & 1 deletion doc/ja/source/algorithm/Lanczos_ja.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Lanczos法では、 :math:`\mathcal{K}_{n}({\mathcal H},\vec{x}_{0})`
T_{n}=V_{n}^{\dagger}{\mathcal H} V_{n}\end{aligned}
と変形されます。 ここで、
:math:`V_{n}`\ \ :math:`\vec{v}_{i}(i=0,1,\dots,n-1)`\
:math:`V_{n}`\ \ :math:`\vec{v}_{i}(i=0,1,\dots,n-1)`\
並べた行列です。 :math:`T_{n}`\ は三重対角行列であり、 その対角成分は
:math:`\alpha_{i}`, 副対角成分は\ :math:`\beta_{i}`\ で与えられます。
この三重対角行列\ :math:`T_{n}`\
Expand Down
2 changes: 1 addition & 1 deletion doc/ja/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@

# General information about the project.
project = u'HΦ マニュアル'
copyright = u'2021, The University of Tokyo'
copyright = u'2022, The University of Tokyo'
author = u'The University of Tokyo'

# The version info for the project you're documenting, acts as replacement for
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ InterAll指定ファイル
なお、スピンに関して計算する場合には、\ :math:`i=j, k=l`\ となるよう設定してください。
また、オフダイアゴナル成分については、i1 sigma1 i2 sigma2 i3 sigma3 i4 sigma4 とi4 sigma4 i3 sigma3 i2 sigma2 i1 sigma1 のペアを必ず用意するようにしてください。
以下にファイル例を記載します。

::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
:math:`U_{\rm quench} \sum_i n_{i \uparrow} n_{i \downarrow}`\ が加えられる。
``"Pulse Laser"``, ``"AC Laser"``, ``"DC Laser"``\ では、
ホッピング項に
:math:`-\sum_{i j \sigma} t_{i j} \exp[-i{\bf A}(t) \cdot ({\bf R}_i-{\bf R}_j)/(2\pi)] c^dagger_{i \sigma} c_{j \sigma}`
:math:`-\sum_{i j \sigma} t_{i j} \exp[-i{\bf A}(t) \cdot ({\bf R}_i-{\bf R}_j)/(2\pi)] c^{\dagger}_{i \sigma} c_{j \sigma}`
のように位相因子が付く。
ここで\ :math:`{\bf A}(t)`\ はベクトルポテンシャルであり、
``"Pulse Laser"``\ では
Expand Down
4 changes: 3 additions & 1 deletion doc/ja/source/howtouse/directorystructure_ja.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ HPhi-xxx.gzを解凍後に構成されるディレクトリ構成を以下に示
|--doc/
| |--en/
| |--ja/
| |--fourier/
| |--tutorial/
| |--tutorial_HPhi_en.pdf
| |--userguide_en.pdf
| |--userguide_jp.pdf
|--README.md
|--samples/
|--src/
| |--*.c
Expand Down
17 changes: 1 addition & 16 deletions doc/ja/source/howtouse/installation_ja.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,13 @@

:math:`{\mathcal H}\Phi` は次の場所からダウンロードできます。

https://github.com/QLMS/HPhi/releases
https://github.com/issp-center-dev/HPhi/releases

ダウンロードしたファイルを次のように展開してください。

``$ tar xzvf HPhi-xxx.tar.gz``

:math:`{\mathcal H}\Phi`\ はcmakeを利用してインストールできます。


.. tip::

| 物性研スパコンシステムであるsekireiとenaga で cmake を利用するには
| ``module load cmake``
| をあらかじめ実行する必要があります。
| なお、両システムでは :math:`{\mathcal H}\Phi` がプレインストールされております。
| 詳しくは `スパコン公式ページ <http://www.issp.u-tokyo.ac.jp/supercom/visitor/softwaredev/softwareall/hphi>`_ をご参照ください。
.. | sekirei で cmake を利用するには
| ``source /home/issp/materiapps/tool/env.sh``
| をあらかじめ実行する必要があります。
:math:`{\mathcal H}\Phi`\ を展開したディレクトリのパスを$PathTohphi
、ビルドディレクトリを$HOME/build/hphi
(任意の場所を指定可能)とした場合に、 ::
Expand Down
2 changes: 1 addition & 1 deletion doc/ja/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Mitsuaki Kawamura, Kazuyoshi Yoshimi, Takahiro Misawa, Youhei Yamaji, Synge Todo

ダウンロード
------------------
:math:`{\mathcal H}\Phi` のソースコードは `GitHub page <https://github.com/QLMS/HPhi>`_ or `release page <https://github.com/QLMS/HPhi/releases>`_ からダウンロードできます。
:math:`{\mathcal H}\Phi` のソースコードは `GitHub page <https://github.com/issp-center-dev/HPhi>`_ or `release page <https://github.com/issp-center-dev/HPhi/releases>`_ からダウンロードできます。


Contents
Expand Down
8 changes: 5 additions & 3 deletions doc/ja/source/introduction_ja.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ What is :math:`{\mathcal H}\Phi`?

本ソフトウェアは以下の開発貢献者により開発されています。

- ver.3.5.1 (2022/6/14 リリース)

- ver.3.5 (2021/9/29 リリース)

- ver.3.4 (2020/6/2 リリース)

- 開発者
Expand Down Expand Up @@ -137,9 +141,7 @@ What is :math:`{\mathcal H}\Phi`?

以下の環境で動作することを確認しています。

- 東京大学物性研究所スーパーコンピューターシステムB「sekirei」、システムC「enaga」

- 富士通 FX-10
- 東京大学物性研究所スーパーコンピューターシステムB「ohtaka」

- Linux PC + intelコンパイラ

Expand Down
9 changes: 1 addition & 8 deletions doc/ja/source/tutorial/fourier_ja.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,4 @@
===============================================

このパッケージには、上で求めた相関関数をフーリエ変換し、プロットするユーティリティーが付属しています。
このユーティリティーに関するマニュアルは ::

doc/fourier/ja/_build/html/index.html
doc/fourier/ja/_build/latex/fourier.pdf
doc/fourier/en/_build/html/index.html
doc/fourier/en/_build/latex/fourier.pdf

にありますので、そちらを参照してください。
詳細についてはAppendix Aをご覧ください。
Loading

0 comments on commit a1e6571

Please sign in to comment.