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
What does this script do?
The above command downloads a script from the MatFlow GitHub repository and runs it. The script does the following:
It downloads the latest prerelease version of MatFlow zip archived in a single folder.
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/matflow. In macOS it is~/Library/Application Support/matflow. In Windows it isUsername\AppData\Local\matflow.A symbolic link (Linux/macOS) or an alias pointing to the file is created. This allows MatFlow to be run by entering a simple command.
A command is added to
.bashrc/.zshrc(linux/macOS) or the Powershell profile (Windows) that allows MatFlow to be run from any folder.
If the script detects that the version of MatFlow it is trying to install is already there, it will stop running and exit.
To check if the installation was successful, run the following command in your terminal:
MatFlow --version
This should print the version of MatFlow that was installed, and will give an error if the installation was not successful.
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#
We recommend you create a virtual Python environment to work with MatFlow to separate versions for different projects and avoid dependency conflicts. Check that you have the correct environment activated by confirming that the name of the environment appears in brackets in your prompt.
MatFlow is compatible with Python versions >=3.9,<3.13. We recommend using the newest version available to you.
Using pip#
Use pip to install the Python package from PyPI:
pip install matflow-new
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 executable | matflow-v0.3.0a145-linux |
| Linux folder | matflow-v0.3.0a145-linux-dir.zip |
| macOS executable | matflow-v0.3.0a145-macOS |
| macOS folder | matflow-v0.3.0a145-macOS-dir.zip |
| Windows folder | matflow-v0.3.0a145-win-dir.zip |
| Windows executable | matflow-v0.3.0a145-win.exe |
Release notes#
Release notes for this version (0.3.0a145) are available on GitHub. Use the version switcher in the top-right corner of the page to download/install other versions.