Metadata-Version: 2.1
Name: aerokit
Version: 1.2.1
Summary: Python tools for basic fluid mechanics computations
Author-email: "J. Gressier" <jeremie.gressier@isae-supaero.fr>
License: MIT License
        
        Copyright (c) 2021 J. Gressier
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/jgressier/aerokit
Project-URL: Documentation, https://aerokit.readthedocs.io/en/latest/
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy >=1.19.4
Requires-Dist: scipy >=1.5.4
Requires-Dist: matplotlib >=3.2
Provides-Extra: dev
Requires-Dist: pytest >=6.0 ; extra == 'dev'
Requires-Dist: pytest-cov >=2.11.1 ; extra == 'dev'
Requires-Dist: pylint >=2.6.0 ; extra == 'dev'
Provides-Extra: doc
Requires-Dist: mkdocs >=1.1 ; extra == 'doc'
Requires-Dist: mkdocs-material >=6.2.5 ; extra == 'doc'
Requires-Dist: mkdocs-jupyter >=0.15 ; extra == 'doc'
Requires-Dist: markdown-include >=0.6.0 ; extra == 'doc'
Requires-Dist: mkdocs-include-markdown-plugin ; extra == 'doc'
Requires-Dist: mkdocs-exclude ; extra == 'doc'
Requires-Dist: mkdocstrings ; extra == 'doc'

# AeroKit

Python packages for compressible flow computations

[![PyPi Version](https://img.shields.io/pypi/v/aerokit.svg?style=flat)](https://pypi.org/project/aerokit)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/aerokit.svg?style=flat)](https://pypi.org/pypi/aerokit/)
[![Doc](https://readthedocs.org/projects/aerokit/badge/?version=latest)](https://aerokit.readthedocs.io/)
[![Slack](https://img.shields.io/static/v1?logo=slack&label=slack&message=contact&style=flat)](https://join.slack.com/t/isae-opendev/shared_invite/zt-obqywf6r-UUuHR4_hc5iTzyL5bFCwpw
)

[![GitHub stars](https://img.shields.io/github/stars/jgressier/aerokit.svg?style=flat&logo=github&label=Stars&logoColor=white)](https://github.com/jgressier/aerokit)
[![PyPi downloads](https://img.shields.io/pypi/dm/aerokit.svg?style=flat)](https://pypistats.org/packages/aerokit)
[![codecov](https://img.shields.io/codecov/c/github/jgressier/aerokit.svg?style=flat)](https://codecov.io/gh/jgressier/aerokit)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/cf3b4b76534f42a1a1fe7c913d2ee782)](https://app.codacy.com/gh/jgressier/aerokit/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

### Features

* Mach dependent functions for isentropic total pressure, temperature and mass flow
* local Rankine-Hugoniot shock wave equations (or 2d planar shocks) and conical shock waves
* Fanno equations for momentum losses in a duct
* Rayleigh equations for heating/cooling in a duct
* unsteady compressible 1D flows
* 1D stability equations: Orr-Sommerfeld and linearized compressible inviscid
* applications:
  * nozzle flows
  * (Riemann) shock tube
  * Channel incompressible flow stability (Poiseuille)
* degree based trigonometric functions
* real gaz and kerozen thermo functions
* Newton iterative solve, ODE integration, Chebyshev spectral discretization

### Installation & usage

    pip install aerokit

Documentation is available on [readthedocs](https://aerokit.readthedocs.io/en/latest/). More examples are available in the repository.

### Requirements

* `numpy`, `scipy`
* examples are plotted using [`matplotlib`](http://matplotlib.org)
