> ## Documentation Index
> Fetch the complete documentation index at: https://compflowlab.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# CompFlowLab: A Python code to develop and prototype new data-driven models for challenging compressible flow problems with shocks and chemical reactions

<Frame>
  <img alt="Compflowlab Logo Dark" title="Compflowlab Logo Dark" lightAlt="Compflowlab Logo Light" darkAlt="Compflowlab Logo Dark" src="https://mintcdn.com/compflowlab/q2EGv9HdPEzd9_KH/images/compflowlab_logo_light.png?fit=max&auto=format&n=q2EGv9HdPEzd9_KH&q=85&s=42221e952ac2d91fc9dad45fe2b55e14" className="dark:hidden" width="1983" height="793" data-path="images/compflowlab_logo_light.png" />

  <img alt="Compflowlab Logo Dark" title="Compflowlab Logo Dark" lightAlt="Compflowlab Logo Light" darkAlt="Compflowlab Logo Dark" src="https://mintcdn.com/compflowlab/q2EGv9HdPEzd9_KH/images/compflowlab_logo_dark.png?fit=max&auto=format&n=q2EGv9HdPEzd9_KH&q=85&s=baa21a3f59a2bb5d0afb6afec2034481" className="hidden dark:block" width="1774" height="887" data-path="images/compflowlab_logo_dark.png" />
</Frame>

CompFlowLab is an open-source Python finite volume solver that combines a one-dimensional compressible Navier–Stokes solver with a modular reduced-order modeling (ROM) framework. It is designed as a simple, easy-to-use testbed where researchers in computational fluid dynamics (CFD) and ROM can quickly prototype and evaluate new methods on problems that are both challenging and computationally manageable.

CompFlowLab is particularly suited for reacting and convection-dominated flows, including supersonic and hypersonic regimes, as well as detonation problems.

This documentation provides a starting point for using CompFlowLab, offering a high-level overview of the solver, guidance on running simulations, and instructions for analyzing results. The underlying mathematical formulations and implemented ROM techniques are introduced briefly, with the focus placed on practical usage.

Both the codebase and this documentation are actively under development and will continue to evolve.

<Card title="Quickstart" horizontal="false" href="quickstart">
  See the minimal setup flow.
</Card>

<Card title="Requirements" horizontal={false} href="requirements">
  Everything you need installed and configured before starting to work with CompFlowLab.
</Card>

<Card title="Test Cases" href="test-cases">
  Overview of available test cases.
</Card>

<Card title="Governing Equation" href="governing-equations">
  Explore the methodology and governing equations behind CompFlowLab
</Card>

<Card title="Available Reduced Order Models" href="available-roms">
  Explore the available reduced-order modeling techniques and frameworks integrated into CompFlowLab.
</Card>

## **Acknowledgment**

The authors acknowledge the supports from the Air Force Office of Scientific Research (AFOSR) through the Center of Excellence Grant FA9550-17-1-0195 (Technical Monitors: Fariba Fahroo, Justin Koo, and Ramakanth Munipalli) and the AFOSR under the grant FA9550- 23-1-0211 (Program managers: Drs. Chiping Li and Fariba Fahroo).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.