Installation#

Release notes: on GitHub

There are two ways of using HPCFlow:

  • HPCFlow CLI (Command Line Interface)

  • The HPCFlow Python package

Both of these options allow workflows to be designed and executed. HPCFlow CLI is recommended for beginners and strongly recommended if you want to run HPCFlow on a cluster. The HPCFlow Python package allows workflows to be designed and explored via the Python API and is recommended for users comfortable working with Python. If you are interested in contributing to the development of HPCFlow, the Python package is the place to start.

HPCFlow CLI and the HPCFlow Python package can both be used simultaneously.

HPCFlow CLI#

Install script (v0.2.0a41)#

HPCFlow CLI can be installed on macOS, Linux or Windows through a terminal or shell prompt.

macOS: Open a terminal, paste the command shown below and press enter.

(touch tmp.sh && curl -fsSL https://raw.githubusercontent.com/hpcflow/install-scripts/main/src/install-hpcflow.sh > tmp.sh && bash tmp.sh --prerelease --path --onefile) ; rm tmp.sh

Linux: Open a shell prompt, paste the command shown below and press enter.

(touch tmp.sh && curl -fsSL https://raw.githubusercontent.com/hpcflow/install-scripts/main/src/install-hpcflow.sh > tmp.sh && bash tmp.sh --prerelease --path --onefile) ; rm tmp.sh

Note that if you’re installing on CSF3 or CSF4 using this method, the proxy module should be loaded first. To do this, paste the command shown below into a the shell prompt and press enter.

module load tools/env/proxy2

Windows: Open a Powershell terminal, paste the command shown below and press enter.

& $([scriptblock]::Create((New-Object Net.WebClient).DownloadString('https://raw.githubusercontent.com/hpcflow/install-scripts/main/src/install-hpcflow.ps1'))) -PreRelease -OneFile

Download binaries (v0.2.0a41)#

Binaries are available in two formats:

  • A single executable file containing everything.

  • A folder containing an executable and supporting files.

Click below to download the HPCFlow binary for your platform (other binary releases are available by using the version switcher in the top-right corner):

Linux executablehpcflow-v0.2.0a41-linux
Linux folderhpcflow-v0.2.0a41-linux-dir.zip
macOS executablehpcflow-v0.2.0a41-macOS
macOS folderhpcflow-v0.2.0a41-macOS-dir.zip
Windows folderhpcflow-v0.2.0a41-win-dir.zip
Windows executablehpcflow-v0.2.0a41-win.exe

The HPCFlow Python package#

Using pip#

Use pip to install the Python package from PyPI:

pip install hpcflow==0.2.0a41