Home

Awesome

MACH-Aero

Documentation Status Build Status

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

Code repositoryFunctionalityDocumentationCI StatusLatest Version
baseClassesShared class definitionsDocumentation StatusBuild StatusPyPI
pySplineB-spline implementationDocumentation StatusBuild StatusGitHub release (latest by date)
pyGeoGeometry definitionDocumentation StatusBuild StatusGitHub release (latest by date)
IDWarpVolume mesh warpingDocumentation StatusBuild StatusGitHub release (latest by date)
ADflowCFD and adjoint solverDocumentation StatusBuild StatusGitHub release (latest by date)
pyOptSparseOptimizer wrapperDocumentation StatusBuild StatusGitHub release (latest by date)
And optional modules:
pyHypVolume mesh generationDocumentation StatusBuild StatusGitHub release (latest by date)
multiPointUtilities for multipoint optimizationDocumentation StatusBuild StatusGitHub release (latest by date)
cgnsUtilitiesUtilities for CGNS mesh filesDocumentation StatusBuild StatusGitHub release (latest by date)
DAFoamAlternate adjoint solver using OpenFOAMDocumentationRegression TestGitHub release (latest by date)

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:

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.