Skip to content

Installation

Preferred Operating System

ZephyCFD-Core might run on much Linux distributions.
We advise here to use Ubuntu 22.04, as it is the operating system running the cloud computations when ZephyFarm is used.

ZephyCFD-Core-GPL

Retrieve the project locally

Terminal
git clone https://github.com/TristanZS/ZephyCFD-Core-GPL.git
mv ZephyCFD-Core-GPL ZephyCFD-Core && cd ZephyCFD-Core

Use of virtual environment

Info

Use of virtual environment is optional.

Terminal
python3 -m venv env
source venv/bin/activate

Tip

Use of virtual environment is not mandatory, but can be usefull to keep some existing library versions.
When this option is activated, user should remind to activate the virtual environment for each new terminal prior to run ZephyCFD-Core (with source venv/bin/activate).

Installing required dependencies

Terminal
sudo bash doc/configure.sh

Success

You should now be ready to start running ZephyCFD-Core!