Skip to content

su2code/VandV_Actions

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VandV_Actions

VandV_Actions is an automation framework that integrates SU2 V&V Test Cases into a GitHub Actions CI/CD pipeline to enable reproducible, traceable and low-effort V&V of CFD solvers


SU2 Validation Framework

The automation framework for Validation Test Cases consists of two coordinated GitHub Actions workflows:

  • Run SU2 Validation Test Cases: Runs SU2 validation test cases end-to-end and generates results + plots.
  • Publish SU2 Validation Test Cases Results: Publishes the generated results to the designated results repository and branch for public sharing.

Key features:

  • Validates user inputs for branch, case category/code, turbulence model and configuration.
  • Traverses case hierarchy conditionally to run selected cases or full suites.
  • Builds SU2 from the chosen branch with pywrapper enabled and MPI disabled.
  • Uploads artifacts and deploys results to a dedicated website branch.
  • Publishes web-ready markdown reports

The detailed description of SU2 Validation Test Cases is available inside ValidationCases directory in the VandV_Actions repository


User's Guide

Main Workflow: Run SU2 Validation Test Cases

  1. Go to the Actions tab in the VandV_Actions repository.
  2. Locate “Run SU2 Validation Test Cases”
  3. Click “Run workflow” (manual trigger).
  4. Fill in the required parameters:
    • SU2 Branch To Check Out – The SU2 branch to build from.
    • Validation Test Case Category – Basic or Extended.
    • Validation Test Case Code – e.g., 2DML, 2DZP, etc.
    • Turbulence Model – SA (Spalart–Allmaras), SST (Shear Stress Transport), etc.
    • Configuration – e.g., Configuration1, Configuration2, or All.
    • Author's Name – Your name or initials (used in results).
  5. Click Run Workflow.

Retrieve Simulation Results

  1. Once the workflow finishes, go to the workflow run page → Artifacts.
  2. Download::
    • Plots
    • CSV/VTU simulation outputs

IF YOU ONLY NEED LOCAL RESULTS, YOU CAN STOP HERE.


Secondary Workflow: Publish SU2 Validation Test Cases Results

  1. Go to the Actions tab in the SU2 Project Website repository.
  2. Locate “Publish SU2 Validation Test Cases Results”.
  3. Click “Run workflow” (manual trigger).
  4. Fill in parameters (Similar to the Main Workflow, ensure they match the run you want to publish).
  5. Click Run Workflow.
  6. Raise a PR to publish results on the official SU2 website

More Information

For more details about SU2 Validation Framework, please visit the official documentation

For more details about SU2, please visit the official SU2 Website


PLEASE NOTE THAT VandV_Actions IS CURRENTLY UNDER DEVELOPMENT.
At present, the framework automates a selected subset of SU2 Validation Test Cases, but soon we will expand to include the complete suite of benchmarks available on NASA’s Turbulence Modeling Resource.

Author : Harsh Mishra

About

Run User Specific Test Cases From The SU2 V&V Database

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages