インストール

BEACH の Python package、beachx、Fortran 実行バイナリ beach は同時にインストールされます。通常の pip install では、Fortran Package Manager (fpm) も隔離された build 環境に自動導入されます。

初回は次の前提を確認してください。

動作要件

項目	要件
OS	主にLinuxで動作確認済み。HPCでは各サイトのcompiler/MPI環境に従う
Python	3.10以上
source取得	git
build tool	make
Fortran	gfortran、Intel Fortranなど

python --version
git --version
make --version
gfortran --version

このドキュメントと一致する版をインストール

このサイトは GitHub の main branch にある設定と出力を説明します。20 batch の公式チュートリアルを 同じ期待値で実行するには、現行 source をインストールします。

python -m pip install -U pip setuptools wheel
python -m pip install "git+https://github.com/Nkzono99/BEACH.git"

確認:

beach --version
beachx --help

beach または beachx が見つからない場合:

python -m site --user-base
export PATH="$HOME/.local/bin:$PATH"

表示されたuser base配下のbinを、shellの設定に追加してください。

PyPI の安定版

python -m pip install beach-bem

PyPI 版は公開時点で固定された安定版です。公開版の beachx config init が作る入門設定は、このサイトの main branch より古い場合があります。その場合は、このサイトの 20 batch 期待値と混ぜず、上の GitHub 版を 使ってください。

checkout を編集しながら使う

checkoutを編集しながら使う場合:

python -m pip install -e . --no-build-isolation

--no-build-isolationは、pyproject.tomlに定義されたbuild dependencyの自動導入を無効にします。 この方法やmakeを直接使う場合は、先にfpmをPATH上に用意してください。

python -m pip install fpm
fpm --version

matching-plane の応答表を作る beach-zhao-response と Zhao の解領域を調べる beach-zhao-atlas は、 現在の source build には含まれますが、PyPI 配布には含まれない場合があります。必要な場合は GitHub 版を インストールし、matching-plane 数値・応答表リファレンスへ進んでください。

更新と削除

python -m pip install -U beach-bem
python -m pip uninstall beach-bem

compilerや開発時のfpmが見つからない場合は、先にOS/HPCのpackage/moduleを設定してください。 失敗例はトラブルシューティングにまとめています。

次は10 分チュートリアルへ進みます。