ezaero
ezaero copied to clipboard
ezaero - Easy aerodynamics in Python :airplane:
.. |travisci| image:: https://img.shields.io/travis/partmor/ezaero/master.svg?style=flat-square&logo=travis :target: https://travis-ci.org/partmor/ezaero
.. |appveyor| image:: https://img.shields.io/appveyor/ci/partmor/ezaero/master.svg?style=flat-square&logo=appveyor :target: https://ci.appveyor.com/project/partmor/ezaero/branch/master
.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square :target: https://github.com/partmor/ezaero/raw/master/LICENSE
.. |docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat-square :target: https://ezaero.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. |pypi_v| image:: https://img.shields.io/pypi/v/ezaero.svg :target: https://pypi.org/project/ezaero/ :alt: Latest PyPI version
.. |pyversions| image:: https://img.shields.io/pypi/pyversions/ezaero.svg :target: https://pypi.org/project/ezaero/ :alt: Python versions
.. |codecov| image:: https://img.shields.io/codecov/c/github/partmor/ezaero.svg?style=flat-square :target: https://codecov.io/github/partmor/ezaero?branch=master
ezaero
|travisci| |appveyor| |codecov| |docs| |license| |pypi_v| |pyversions|
ezaero (easy-aero) is an open source Python package oriented to implement numerical methods for Aerodynamics, such as the 3D Vortex lattice Method for lifting surfaces.
.. image:: https://github.com/partmor/ezaero/raw/master/docs/examples/cl_distribution.png :align: center :width: 200px
Documentation
|docs|
API documentation and examples can be found on https://ezaero.readthedocs.io.
Examples
You can check out the examples in the gallery
_, and export them as .py scripts or Jupyter notebooks to continue exploring!
.. _gallery
: https://ezaero.readthedocs.io/en/latest/auto_examples/
Installation
To install the package, simply use pip:
.. code-block::
$ pip install ezaero
Requirements
ezaero has the following dependencies:
- Python (>=3.7)
- NumPy
- matplotlib
ezaero is tested on Linux, Windows and OS X on Python 3.7 and 3.8.
============== ============ =================== Platform Site Status ============== ============ =================== Linux / OS X Travis CI |travisci| Windows x64 Appveyor |appveyor| ============== ============ ===================
Contributing
All contributions and suggestions are welcome! For more details, check out CONTRIBUTING.rst
_.
.. _CONTRIBUTING.rst
: https://github.com/partmor/ezaero/blob/master/CONTRIBUTING.rst
Motivation
This library is a free-time project. I am using as a means to:
- Experiment the performance of several scientific computing packages and tools applied to a computation-intensive application.
- Dive deep into the Python Open Source community.
- Redo properly (in terms of performance optimization, SW best practices, ...) a project I enjoyed a lot during my Master Thesis, back in 2014.
My thesis covered the analysis of the aeroelastic response of an UAV in a gust scenario.
My plan is to implement the following modules:
- 3D steady VLM [Done]
- 3D unsteady VLM
- Wing motion equation solver (aeroelastic response)
If for some reason you run across this project, and find it useful or have suggestions,
don't be shy! feel free to contribute or drop me a line <mailto:[email protected]>
_.