Metadata-Version: 2.4
Name: pymfoil
Version: 0.1.0
Summary: A Python package for aerodynamic airfoil analysis based on mfoil.
Author-email: "N. Papadakis" <npapnet@gmail.com>
License: MIT License
Project-URL: Homepage, https://github.com/npapnet/pymfoil
Project-URL: Bug Tracker, https://github.com/npapnet/pymfoil/issues
Project-URL: Repository, https://github.com/npapnet/pymfoil
Project-URL: Documentation, https://npapnet.github.io/pymfoil/
Project-URL: Source, https://github.com/npapnet/pymfoil
Keywords: airfoil,aerodynamics,naca,engineering
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.21.0
Requires-Dist: matplotlib>=3.5.0
Requires-Dist: scipy
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Dynamic: license-file

# pymfoil

Repository for a pypi version of mfoil project.  The mfoil code is a Matlab code for analysis of airfoils using similar physical models like XFOIL with some difference in the couple solver. [`Mfoil`](https://websites.umich.edu/~kfid/codes.html) is developed maintained by [Krzysztof J. Fidkowski](https://websites.umich.edu/~kfid/)

This [package and its repository](https://github.com/npapnet/pymfoil) is maintained by N. Papadakis (https://github.com/npapnet).

## Aim of this work 

The aim of this work is to:
- make the mfoil code available as a python package.
- Add a gui for easier use of the code
- add new features like:
  - batch projcessing of attack angles and airfoils
  - exporting results in csv format depending on user needs 

# Installation

To install the package, run the following command:

## Using pip

The easiest method to install pymfoil is via pip:

```
pip install pymfoil
```

## clone and install locally 

clone the repository and install it locally using pip:

```
git clone https://github.com/npapnet/pymfoil.git
cd pymfoil
pip install .
```

# Usage

Work in progreess

# License

This project uses the MIT License - see the LICENSE file for details.
