/MACH-Aero

MACH: MDO of Aircraft Configurations with High fidelity

Primary LanguagePython

MACH-Aero

Documentation Status

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

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

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

These documentation can be accessed online at https://mdolab-mach-aero.readthedocs-hosted.com/. To run the tutorials yourself, you need to 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.