README.md

MACH-Aero

MACH-Aero is a framework for performing aerodynamic shape optimization. It contains the following core modules:

Code repository	Functionality	Documentation	CI Status	Latest Version
baseClasses	Shared class definitions
pySpline	B-spline implementation
pyGeo	Geometry definition
IDWarp	Volume mesh warping
ADflow	CFD and adjoint solver
pyOptSparse	Optimizer wrapper
And optional modules:
pyHyp	Volume mesh generation
multiPoint	Utilities for multipoint optimization
DAFoam	Alternate adjoint solver using OpenFOAM
cgnsUtilities	Utilities for CGNS mesh files

Where is the code?

All the code for MACH-Aero are contained within the individual repositories, which you can go to by clicking on the names in the table above. To go to the documentation site for each repository, click on the badge in the documentation column of the table above.

What's in this repo then?

This repository contains the following:

• A description of the overall framework
• Installation instructions which are shared across the various repositories
• Tutorials for using MACH-Aero to perform aerodynamic shape optimization

This documentation can be accessed online here. To run the tutorials, follow the installation instructions to install all the modules, then clone this repository to access the tutorial scripts. To compile the doc locally, first install dependencies via pip install -r requirements.txt, then build locally with make html.