Installation

There are two ways of using hpcFlow:

• The hpcFlow command-line interface (CLI)

• The hpcFlow Python package

Both of these options allow workflows to be designed and executed. The hpcFlow CLI is recommended for beginners and strongly recommended if you want to run hpcFlow on a cluster. The 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.

The CLI and the Python package can be used simultaneously.

hpcFlow CLI

The hpcFlow CLI can be installed on Linux, macOS, and Windows through a terminal or shell prompt:

Linux/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 --univlink) ; rm tmp.sh

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 -UnivLink

What does this script do?

The above command downloads a script from the hpcFlow GitHub repository and runs it. The script does the following:

1. It downloads the latest prerelease version of hpcFlow zip archived in a single folder.

2. The archive is extracted and the folder placed in an accessible location. The location depends on the operating system. In Linux it is /.local/share/hpcflow. In macOS it is ~/Library/Application Support/hpcflow. In Windows it is Username\AppData\Local\hpcflow.

3. A symbolic link (Linux/macOS) or an alias pointing to the file is created. This allows hpcFlow to be run by entering a simple command.

4. A command is added to .bashrc/.zshrc (linux/macOS) or the Powershell profile (Windows) that allows hpcFlow to be run from any folder.

If the script detects that the version of hpcFlow it is trying to install is already there, it will stop running and exit.

Hint

If you are installing hpcFlow on an HPC resource, check that you can connect to the internet first. You might need to load a proxy module, for example.

hpcFlow Python package

Using pip

Use pip to install the Python package from PyPI:

pip install hpcflow-new2=="0.2.0a190"

Using conda

Coming soon!

Download CLI binaries (advanced)

Binaries are available in two formats, corresponding to the two different formats that PyInstaller can generate:

• A single executable file containing everything.

• A folder containing an executable and supporting files.

Click below to download the hpcFlow binary for your platform:

Linux executable	hpcflow-v0.2.0a190-linux
Linux folder	hpcflow-v0.2.0a190-linux-dir.zip
macOS executable	hpcflow-v0.2.0a190-macOS
macOS folder	hpcflow-v0.2.0a190-macOS-dir.zip
Windows folder	hpcflow-v0.2.0a190-win-dir.zip
Windows executable	hpcflow-v0.2.0a190-win.exe

Release notes

Release notes for this version (0.2.0a190) are available on GitHub. Use the version switcher in the top-right corner of the page to download/install other versions.