Installation#

There are two ways of using MatFlow:

  • The MatFlow command-line interface (CLI)

  • The MatFlow Python package

Both of these options allow workflows to be designed and executed. The MatFlow CLI is recommended for beginners and strongly recommended if you want to run MatFlow 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 MatFlow, the Python package is the place to start.

The CLI and the Python package can be used simultaneously.

MatFlow CLI#

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

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-matflow.sh > tmp.sh && bash tmp.sh --prerelease --path --univlink) ; rm tmp.sh

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-matflow.ps1'))) -PreRelease -UnivLink

Hint

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

MatFlow Python package#

Using pip#

Use pip to install the Python package from PyPI:

pip install matflow-new=="0.3.0a129"

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 MatFlow binary for your platform:

Linux executablematflow-v0.3.0a129-linux
Linux foldermatflow-v0.3.0a129-linux-dir.zip
macOS executablematflow-v0.3.0a129-macOS
macOS foldermatflow-v0.3.0a129-macOS-dir.zip
Windows foldermatflow-v0.3.0a129-win-dir.zip
Windows executablematflow-v0.3.0a129-win.exe

Release notes#

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