aqreed / PyVLM

Vortex Lattice Method library written in Python

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status codecov.io license Binder

PyVLM

Description Python Vortex Lattice Method
Author AeroPython Team aeropython@groups.io
Version 0.0.1
Python Version 3.6
Requires Numpy, Matplotlib

Installation

PyVLM has been written in Python3, and its version v0.1.1 is available in PyPi. It can be installed using:

$ pip install vlm

To install in development mode:

$ git clone https://github.com/aqreed/PyVLM.git
$ cd PyVLM
$ pip install -e .

Please find a example notebook on the 'examples' folder that you can open locally, or just try Binder to launch online interactive Jupyter notebooks.


NOTE: PyVLM is under development and might change in the near future.


Dependencies

This package depends on Python, NumPy and Matplotlib and is usually tested on Linux with the following versions:

Python 3.6, NumPy 1.16, Matplotlib 3.0

Testing

PyVLM recommends py.test for running the test suite. Running from the top directory:

$ pytest

To test coverage (also from the top directory):

$ pytest --cov

Bug reporting

Please feel free to open an issue on GitHub!

License

MIT (see COPYING)

About

Vortex Lattice Method library written in Python

License:MIT License


Languages

Language:Jupyter Notebook 66.7%Language:Python 33.3%