Installation with Python virtual environment
Supported Platforms
- Windows 10 or newer
- macOS 10.14 or newer (Apple Silicon only)
- Ubuntu 20.04 or newer
- CentOS 8.2 or alternatives ( Rocky Linux, AlmaLinux, … )
- OpenSUSE Leap 15.4
- Linux Mint 21 “Vanessa”
BARAM requires following installed software:
- Python 3.9.x
- MS-MPI 10.0 or newer ( Windows Only )
- OpenMPI 4.1 or newer ( Linux, macOS )
- GNU C Compiler or any other C Compiler ( Linux, macOS )
Clone the source code
git clone https://github.com/nextfoam/baram.git
cd baram
Setup Python virtual environment
Run following command in the top directory of downloaded source code. Please don’t forget that Python 3.9.x is required. You can check it with the command of python3 -V
.
python3.9 -m venv venv
Enter into virtual environment
Run following command in the top directory of downloaded source code
On Windows
.\venv\Scripts\activate.bat
On Linux or macOS
source ./venv/bin/activate
Upgrade pip version
pip install --upgrade pip
Install Python packages
Run following command in the top directory of downloaded source code
pip install -r requirements.txt
Install QT Advanced Docking System package
Run following command in the top directory of downloaded source code
On Windows
pip install https://d3c6e16xufx1gb.cloudfront.net/wheels/PySide6_QtAds-4.2.1.2.dev0-cp38-abi3-win_amd64.whl
On Linux
pip install https://d3c6e16xufx1gb.cloudfront.net/wheels/PySide6_QtAds-4.2.1.2.dev0-cp38-abi3-linux_x86_64.whl
Copy Solver Executables
Download and uncompress solver executables into the top directory of downloaded source code. The compressed files have solvers folder in it. Put solvers folder into the top directory. The final directory structure may look like following.
($BARAM)
|
+-- requirements.txt
+-- ...
+-- solvers/
| |
| +-- openfoam/
| |
| +-- bin/
| +-- etc/
| +-- ...
+-- ...
Windows
solvers_windows_24.4.0_20240923.zip
Linux
solvers_linux_24.4.0_20240923.tar.xz
You can download the file on command line with cURL or wget command like following.
wget https://d3c6e16xufx1gb.cloudfront.net/solvers_linux_24.4.0_20240923.tar.xz
curl -L https://d3c6e16xufx1gb.cloudfront.net/solvers_linux_24.4.0_20240923.tar.xz -o solvers_linux_24.4.0_20240923.tar.xz
macOS (Apple Silicon only)
Not yet prepared due to the strict code signing policy from Apple
Compile Daemonizer ( only for Linux and macOS )
“solvers” directory was created when the compressed file was uncompressed.
gcc -o solvers/openfoam/bin/baramd misc/baramd.c
Compile Resource Files
python convertUi.py
Run BaramFlow
python -m baramFlow.main
Run BaramMesh
python -m baramMesh.main
Convenient Scripts that do not require manual venv activation
baramFlow.sh
baramMesh.sh
Paraview [Optional]
BaramFlow has a menu that can launch ParaView for convenience. If ParaView is installed in the system, this menu launches ParaView in the case foler.