1. 基本的な使用方法

  • 必要なライブラリ・環境

    H-waveを利用するには、以下のプログラムとライブラリが必要です。

    • python 3.x

    • numpy モジュール

    • scipy モジュール

    • requests モジュール

    • tomli モジュール

    なお、H-waveのUHFkとRPAモードでは numpy.fft をFFT計算に利用しています。

  • Official Page

  • ダウンロード方法

    gitを利用できる場合は、以下のコマンドでH-waveをダウンロードすることができます。

    $ git clone https://github.com/issp-center-dev/H-wave.git
    
  • インストール方法

    • PyPI から

      H-wave は PyPI ソフトウェアリポジトリに登録されています。以下のコマンドで H-wave を インストールできます。

      $ pip install h-wave
      
    • ソースパッケージから

      H-wave のソースパッケージは配布サイトから取得できます。

      https://github.com/issp-center-dev/H-wave/releases

      また、git を用いて最新版を開発サイトからダウンロードできます。

      $ git clone https://github.com/issp-center-dev/H-wave.git
      

      H-waveをダウンロード後、以下のコマンドを実行してインストールします。 H-waveが利用するライブラリも必要に応じてインストールされます。

      $ cd ./H-wave
      $ pip install .
      
  • ディレクトリ構成

    .
    |-- LICENSE
    |-- README.md
    |-- pyproject.toml
    |-- docs/
    |   |-- en/
    |   |-- ja/
    |   |-- tutorial/
    |
    |-- src/
    |   |-- qlms.py
    |   |-- hwave/
    |       |-- __init__.py
    |       |-- qlms.py
    |       |-- qlmsio/
    |       |   |-- __init__.py
    |       |   |-- read_input.py
    |       |   |-- read_input_k.py
    |       |   |-- wan90.py
    |       |-- solver/
    |           |-- __init__.py
    |           |-- base.py
    |           |-- uhfr.py
    |           |-- uhfk.py
    |           |-- rpa.py
    |           |-- perf.py
    |-- tests/
    
  • 基本的な使用方法

    1. 入力ファイルの作成

      最初にH-wave用の入力ファイルを作成します。計算条件や入出力ファイル・ディレクトリなどの指定と、Hamiltonianの定義ファイルなどを作成する必要があります。 後者は、StdFaceライブラリ の利用が便利です。 各ファイルの簡単な紹介はチュートリアルの章に記載されています。 詳細についてはファイルフォーマットの章を参照してください。

    2. コマンドの実行

      入力ファイルのあるディレクトリで、以下のコマンドを実行することで、計算が行われます。

      $ hwave input.toml
      

      または、

      $ python3 path_to_H-wave/qlms.py input.toml
      

      計算終了後、計算結果が出力ディレクトリに出力されます。 出力ファイルの詳細については、ファイルフォーマットの章を参照してください。