Caeroc

.. raw:: html

<div align="center"> <a href="https://pypi.python.org/pypi/caeroc/"> <picture> <source srcset="https://raw.githubusercontent.com/ashwinvis/caeroc/refs/heads/main/docs/logos/Caeroc-label-white.svg" media="(prefers-color-scheme: dark)"> <img src="https://raw.githubusercontent.com/ashwinvis/caeroc/refs/heads/main/docs/logos/Caeroc-label.svg" width="35%" alt="attrs" /> </picture> </a> <p><i>Compressible Aerodynamics Calculator for Python</i></p> </div> <div align="center"> <a href="https://pypi.python.org/pypi/caeroc/"> <img alt="Latest version" src="https://img.shields.io/pypi/v/caeroc.svg" /> </a> <a href="/LICENSE"> <img alt="https://img.shields.io/badge/license-GPL-blue.svg" src="https://img.shields.io/badge/license-GPL-blue.svg" /> </a> </div>

A python package for compressible flows. A dynamic toolkit which enables you to make use of the formulae governing compressible flows.

.. figure:: https://raw.githubusercontent.com/ashwinvis/caeroc/gh-pages/screenshot.png :alt: Screenshot

.. figure:: https://raw.githubusercontent.com/ashwinvis/caeroc/gh-pages/caeroc-video.png :alt: Demo. Click to see the full video :align: right :target: https://tube.tchncs.de/w/21xYGCA4DDzkaeFKwq6Gy5

Requirements

• Python 3.10
• pylab (numpy, scipy and matplotlib)
• scikit-aero >= 0.2
• PyQt5 / PySide2 (optional, but recommended for GUI)
• pandas (optional: for making tables)
• colorlog (optional: for coloured log)

Installation

To install from PyPI:

.. code:: bash

# Any of the following
pip install caeroc
pip install caeroc[pyqt]
pip install caeroc[pyside]

To install development versions of caeroc and scikit-aero

.. code:: bash

pip install 'caeroc[pyqt] @ https://github.com/ashwinvis/caeroc/archive/main.zip'
# or
pip install 'caeroc[pyside] @ https://github.com/ashwinvis/caeroc/archive/main.zip'

If the current configuration of the GUI does not work for you, regenerate it by running:

.. code:: bash

cd caeroc/gui
./configure

Launch

Simply run in your terminal

.. code:: bash

caeroc-app

Features

• [x] Command-line tool which opens a Qt based GUI calculator

  In development

• [ ] Save data as a database

• [ ] Plotting graphs

• [ ] Generate gas tables

• [ ] Calculate flow characteristics: Coefficient of pressure, lift and drag for basic profiles.

Courtesy

• The idea for a compressible aerodynamics calculator in the form an online JS tool had been implemented by William Devenport <https://www.aoe.vt.edu/people/faculty/devenport.html>__ here <https://web.archive.org/web/20221106025044/http://www.dept.aoe.vt.edu/~devenpor/aoe3114/calc.html>__. This project is pushing more functionalities as an offline tool and allowing users to dynamically use the formulae for specific cases.
• Thanks to the scikit-aero team for being the backend