Manual Installation Guide

This guide provides instructions on how to manually install and run CFD-HOWL without using Docker. This approach is suitable for users who prefer to manage dependencies directly on their system.

Prerequisites

Before you begin, ensure that your system has the following installed:

• Python 3.8 or higher
• pip (Python package installer)
• git (for cloning the repository)

Step 1: Clone the CFD-HOWL Repository

First, clone the CFD-HOWL repository to your local machine:

git clone https://github.com/RayanDhib/CFD-HOWL.git
cd CFD-HOWL

Step 2: Install Python Dependencies

Next, install the required Python packages using pip. These dependencies include numpy, scipy, vtk, and pyCGNS:

pip install numpy scipy vtk

For pyCGNS, you will need to follow these steps:

1. Clone the pyCGNS repository:

   git clone https://github.com/pyCGNS/pyCGNS.git
   cd pyCGNS

2. Install pyCGNS:

   python setup.py install

Step 3: Verify config.json

The config.json file in the root directory is already configured with the correct paths to run the provided example. The example is the result of the simulation of an inviscid subsonic flow through a channel with a sinusoidal bump in 2D using Flux Reconstruction (P3).

Here’s how the config.json file is set up:

{
    "filename": "./examples/example1.CFmesh",
    "output_filename": "./examples/output1.cgns",
    "var_names": ["rho", "rhoU", "rhoV", "rhoE"]
}

• filename: Path to the input CFmesh file.
• output_filename: Path where the output CGNS file will be saved.
• var_names: Names of the quantities provided by the CFD solver.

You generally do not need to modify this file unless you move the example files to different locations or you are using different inputs. However, it's a good idea to verify that the paths match your local setup.

Step 4: Run CFD-HOWL

To run CFD-HOWL, execute the main.py script:

python main.py

This script will process the input data specified in config.json and generate a high-order CGNS file in the output directory.

Step 5: Review the Output

After running the script, the output CGNS file will be available in the directory specified in config.json. You can open this file with visualization tools such as ParaView or Tecplot to inspect the high-order data.

Troubleshooting

If you encounter any issues, please refer to our Troubleshooting page for help.