diff --git a/docs/en/source/about/index.rst b/docs/en/source/about/index.rst new file mode 100644 index 0000000..aa2a7e4 --- /dev/null +++ b/docs/en/source/about/index.rst @@ -0,0 +1,72 @@ +**************************************************************** +What is H-wave? +**************************************************************** + +Introduction +---------------------------------------------------------------- + +H-wave is a program to perform unrestricted Hartree-Fock (UHF) approximation and random phase approximation (RPA) for itinerant electron systems. +It is based on mean field approximation, and it enables calculations of complicated Hamiltonian and large lattices at low compuational cost. + +License +---------------------------------------------------------------- + +The distribution of the program package and the source codes for H-wave follow GNU General Public License version 3 (GPL v3) or later. + +Contributors +---------------------------------------------------------------- + +This software was developed by the following contributors. + +- ver.1.0.0 (released on 2023/04/25) + + - Developers + + - Kazuyoshi Yoshimi + (The Institute for Solid State Physics, The University of Tokyo) + + - Tatsumi Aoyama + (The Institute for Solid State Physics, The University of Tokyo) + + - Yuichi Motoyama + (The Institute for Solid State Physics, The University of Tokyo) + + - Takahiro Misawa + (The Institute for Solid State Physics, The University of Tokyo) + + - Kota Ido + (The Institute for Solid State Physics, The University of Tokyo) + + - Akito Kobayashi + (Department of Physics, Nagoya University) + + - Taiki Kawamura + (Department of Physics, Nagoya University) + + - Project coordinator + + - Takeo Kato + (The Institute for Solid State Physics, The University of Tokyo) + + +Copyright +---------------------------------------------------------------- + +© *2022- The University of Tokyo. All rights reserved.* + +This software was developed with the support of "Project for advancement of software usability in materials science" of The Institute for Solid State Physics, The University of Tokyo. + + +Operating environment +---------------------------------------------------------------- + +H-wave was tested on the following platforms + +- macOS + python3 (brew) + +- Ubuntu Linux + python3 (miniconda) + +Reference +---------------------------------------------------------------- + +"H-wave -- A Python package for the Hartree-Fock approximation and the random phase approximation", Tatsumi Aoyama, Kazuyoshi Yoshimi, Kota Ido, Yuichi Motoyama, Taiki Kawamura, Takahiro Misawa, Takeo Kato, and Akito Kobayashi, `arXiv:2308.00324 [cond-mat.str-el] `_. diff --git a/docs/en/source/index.rst b/docs/en/source/index.rst index ec23325..59fb7d2 100644 --- a/docs/en/source/index.rst +++ b/docs/en/source/index.rst @@ -2,70 +2,6 @@ Welcome to H-wave documentations! ##################################################### -What is H-wave? ----------------------------------------------------------------- - -H-wave is a program to perform unrestricted Hartree-Fock (UHF) approximation and random phase approximation (RPA) for itinerant electron systems. -It is based on mean field approximation, and it enables calculations of complicated Hamiltonian and large lattices at low compuational cost. - -License ----------------------------------------------------------------- - -The distribution of the program package and the source codes for H-wave follow GNU General Public License version 3 (GPL v3) or later. - -Contributors ----------------------------------------------------------------- - -This software was developed by the following contributors. - -- ver.1.0.0 (released on 2023/04/25) - - - Developers - - - Kazuyoshi Yoshimi - (The Institute for Solid State Physics, The University of Tokyo) - - - Tatsumi Aoyama - (The Institute for Solid State Physics, The University of Tokyo) - - - Yuichi Motoyama - (The Institute for Solid State Physics, The University of Tokyo) - - - Takahiro Misawa - (The Institute for Solid State Physics, The University of Tokyo) - - - Kota Ido - (The Institute for Solid State Physics, The University of Tokyo) - - - Akito Kobayashi - (Department of Physics, Nagoya University) - - - Taiki Kawamura - (Department of Physics, Nagoya University) - - - Project coordinator - - - Takeo Kato - (The Institute for Solid State Physics, The University of Tokyo) - - -Copyright ----------------------------------------------------------------- - -© *2022- The University of Tokyo. All rights reserved.* - -This software was developed with the support of "Project for advancement of software usability in materials science" of The Institute for Solid State Physics, The University of Tokyo. - - -Operating environment ----------------------------------------------------------------- - -H-wave was tested on the following platforms - -- macOS + python3 (brew) - -- Ubuntu Linux + python3 (miniconda) - Contents ---------------------------------------------------------------- @@ -74,6 +10,7 @@ Contents :maxdepth: 3 :numbered: 3 + about/index howtouse/ho-index uhfr/uhfr-index uhfk/uhfk-index diff --git a/docs/ja/source/about/index.rst b/docs/ja/source/about/index.rst new file mode 100644 index 0000000..e0bca6e --- /dev/null +++ b/docs/ja/source/about/index.rst @@ -0,0 +1,62 @@ +**************************************************************** +H-waveとは？ +**************************************************************** + +はじめに +---------------------------------------------------------------- + +H-waveは遍歴電子系を対象に非制限Hartree-Fock(UHF)近似計算および乱雑位相近似(RPA)計算を行うためのプログラムです。 +平均場近似をベースとした近似計算であるため、計算コストが軽く、複雑なハミルトニアンや大きいサイズでの計算が可能です。 + +ライセンス +---------------------------------------------------------------- + +本ソフトウェアのプログラムパッケージおよびソースコード一式はGNU General Public License version 3 (GPL v3) に準じて配布されています。 + +開発貢献者 +---------------------------------------------------------------- + +本ソフトウェアは以下の開発貢献者により開発されています。 + +- ver.1.0.0 (2023/04/25リリース) + + - 開発者 + + - 吉見 一慶 (東京大学 物性研究所) + + - 青山 龍美 (東京大学 物性研究所) + + - 本山 裕一 (東京大学 物性研究所) + + - 三澤 貴宏 (東京大学 物性研究所) + + - 井戸 康太 (東京大学 物性研究所) + + - 小林 晃人 (名古屋大学 理学研究科) + + - 川村 泰喜 (名古屋大学 理学研究科) + + - プロジェクトコーディネーター + + - 加藤 岳生 (東京大学 物性研究所) + +コピーライト +---------------------------------------------------------------- + +© *2022- The University of Tokyo. All rights reserved.* + +本ソフトウェアは2022年度 東京大学物性研究所 ソフトウェア高度化プロジェクトの支援を受け開発されており、その著作権は東京大学が所持しています。 + +動作環境 +---------------------------------------------------------------- + +以下の環境で動作することを確認しています。 + +- macOS + python3 (brew) + +- Ubuntu Linux + python3 (miniconda) + +参考文献 +---------------------------------------------------------------- +"H-wave -- A Python package for the Hartree-Fock approximation and the random phase approximation", +Tatsumi Aoyama, Kazuyoshi Yoshimi, Kota Ido, Yuichi Motoyama, Taiki Kawamura, Takahiro Misawa, Takeo Kato, and Akito Kobayashi, `arXiv:2308.00324 [cond-mat.str-el] `_ diff --git a/docs/ja/source/index.rst b/docs/ja/source/index.rst index 7896be5..8ea9f01 100644 --- a/docs/ja/source/index.rst +++ b/docs/ja/source/index.rst @@ -2,67 +2,15 @@ H-waveのドキュメントへようこそ！ ##################################################### -H-waveとは？ ------------------------------------------- -H-waveは遍歴電子系を対象に非制限Hartree-Fock(UHF)近似計算および乱雑位相近似(RPA)計算を行うためのプログラムです。 -平均場近似をベースとした近似計算であるため、計算コストが軽く、複雑なハミルトニアンや大きいサイズでの計算が可能です。 - -ライセンス --------------- -本ソフトウェアのプログラムパッケージおよびソースコード一式はGNU General Public License version 3 (GPL v3) に準じて配布されています。 - -開発貢献者 --------------- - -本ソフトウェアは以下の開発貢献者により開発されています。 - -- ver.1.0.0 (2023/04/25リリース) - - - 開発者 - - - 吉見 一慶 (東京大学 物性研究所) - - - 青山 龍美 (東京大学 物性研究所) - - - 本山 裕一 (東京大学 物性研究所) - - - 三澤 貴宏 (東京大学 物性研究所) - - - 井戸 康太 (東京大学 物性研究所) - - - 小林 晃人 (名古屋大学 理学研究科) - - - 川村 泰喜 (名古屋大学 理学研究科) - - - プロジェクトコーディネーター - - - 加藤 岳生 (東京大学 物性研究所) - -コピーライト ------------------- - -© *2022- The University of Tokyo. All rights reserved.* - -本ソフトウェアは2022年度 東京大学物性研究所 ソフトウェア高度化プロジェクトの支援を受け開発されており、その著作権は東京大学が所持しています。 - -動作環境 --------- - -以下の環境で動作することを確認しています。 - -- macOS + python3 (brew) - -- Ubuntu Linux + python3 (miniconda) - Contents ----------- - .. toctree:: :maxdepth: 3 :numbered: 3 + about/index howtouse/ho-index uhfr/uhfr-index uhfk/uhfk-index