Installation

Installing the BEACH Python package also installs beachx and builds the Fortran beach executable. A normal pip install automatically installs the Fortran Package Manager (fpm) into the isolated build environment.

Requirements

Item	Requirement
OS	Linux is the primary tested environment; use site compiler/MPI modules on HPC systems
Python	3.10 or newer
Source retrieval	git
Build tool	make
Fortran	gfortran, Intel Fortran, or another fpm-compatible compiler

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

Install the version described by this site

This site documents the configuration and output behavior on the GitHub main branch. Install the current source to reproduce the official 20-batch tutorial and its expected values.

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

If the commands are not found, inspect the user base and add its bin directory to PATH:

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

Stable release from PyPI

python -m pip install beach-bem

The PyPI package is a stable snapshot. Its beachx config init tutorial may lag behind the main branch documented by this site. Do not combine an older generated case with the 20-batch expected values; use the GitHub installation above when following this site.

Work from an editable checkout

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

--no-build-isolation disables automatic installation of the build dependencies declared in pyproject.toml. Install fpm on PATH before using this mode or invoking make directly.

python -m pip install fpm
fpm --version

Current source builds also provide beach-zhao-response for matching-plane response tables and beach-zhao-atlas for Zhao solvability maps. PyPI distributions may not include these auxiliary executables. Install the GitHub version above when you need them, then continue with the matching-plane numerical and response-table reference.

Upgrade or remove

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

See Troubleshooting for compiler, fpm, PATH, and runtime failures. Continue with the Ten-Minute Tutorial.