changed (again) the name of the package to *vlm*

Author: aqreed

README.md

@@ -3,21 +3,53 @@
 | ------ | ------ |
 | Description | Python Vortex Lattice Method |
 | Author | AeroPython Team <aeropython@groups.io> |
-| Version | 0.0.dev0 |
+| Version | 0.0.1 |
 | Python Version | 3.6 |
 | Requires | Numpy, Matplotlib |
 
 ### Installation
 
-PyVLM has been written in Python3
+PyVLM has been written in Python3. To install in development mode:
 
 ```sh
-$ cd ~/Desktop (or wherever you feel like)
 $ git clone https://github.com/aqreed/PyVLM.git
 $ cd PyVLM
-$ python setup.py install
+$ pip install -e .
 ```
 
+Please find a example notebook on the ['examples'](https://github.com/aqreed/PyVLM/tree/dev/examples) folder that you can open locally, or just try [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/aqreed/PyVLM/dev?filepath=examples) 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:
+
+```sh
+$ pytest
+```
+
+To test coverage (also from the top directory):
+
+```sh
+$ pytest --cov
+```
+
+### Bug reporting
+
+Please feel free to open an [issue](https://github.com/aqreed/PyVLM/issues) on GitHub!
+
 ### License
 
 MIT (see `COPYING`)

examples/example_pilatusPC12.ipynb

@@ -18,7 +18,7 @@
 import numpy as np
 import matplotlib.pyplot as plt
 
-from pyvlm.vlm import PyVLM
+from vlm import PyVLM
 
 
 pilatusPC12 = PyVLM()

examples/pilatusPC12.ipynb

@@ -4,14 +4,14 @@
     long_description = fh.read()
 
 setup(
-    name="vlmpy",
+    name="vlm",
     author='aqreed',
     description='Python Vortex Lattice Method',
     long_description=long_description,
     long_description_content_type='text/markdown',
     version="0.0.1",
-    url='https://github.com/aqreed/vlmpy',
-    packages=['vlmpy'],
+    url='https://github.com/aqreed/PyVLM',
+    packages=['vlm'],
     install_requires=['numpy', 'matplotlib'],
     tests_requires=['pytest']
     )

examples/example_pilatusPC12.py examples/pilatusPC12.py

@@ -7,7 +7,7 @@
 import numpy as np
 from numpy.testing import assert_almost_equal
 
-from vlmpy.airfoils import NACA4
+from vlm.airfoils import NACA4
 
 
 def test_camber_line():

setup.py

@@ -7,7 +7,7 @@
 import numpy as np
 from numpy.testing import assert_almost_equal
 
-from vlmpy.geometry import (cross_prod, vect_dot, norm_dir_vect,
+from vlm.geometry import (cross_prod, vect_dot, norm_dir_vect,
                             dist_point2line, area_4points)
 
 

tests/test_airfoils.py

@@ -7,7 +7,7 @@
 import numpy as np
 from numpy.testing import assert_almost_equal
 
-from vlmpy.mesh_generator import Mesh
+from vlm.mesh_generator import Mesh
 
 
 def test_mesh_points():

tests/test_geometry.py

@@ -7,7 +7,7 @@
 import numpy as np
 from numpy.testing import assert_almost_equal
 
-from vlmpy.panel import Panel
+from vlm.panel import Panel
 
 
 def test_area():

tests/test_mesh_generator.py

@@ -7,7 +7,7 @@
 import numpy as np
 from numpy.testing import assert_almost_equal
 
-from vlmpy.vlm import PyVLM
+from vlm.vlm import PyVLM
 
 
 def test_add_wing():

tests/test_panel.py

@@ -7,7 +7,7 @@
 import numpy as np
 from numpy.testing import assert_almost_equal
 
-from vlmpy.vortices import (vortex_position_in_panel,
+from vlm.vortices import (vortex_position_in_panel,
                             v_induced_by_horseshoe_vortex,
                             v_induced_by_finite_vortex_line)
 

tests/test_vlm.py

@@ -4,9 +4,5 @@
 Distributed under the terms of the MIT License.
 """
 
-from .airfoils import *
-from .geometry import *
-from .mesh_generator import *
-from .panel import *
+
 from .vlm import *
-from .vortices import *

tests/test_vortices.py

@@ -261,12 +261,12 @@ def vlm(self, alpha, print_output=False):
             Panel[i].gamma = gamma[i]
             Panel[i].l = V * rho * Panel[i].gamma * Panel[i].span
             Panel[i].cl = Panel[i].l / (q_inf * Panel[i].area)
-             
+
             d0 = (Panel[i].l * Panel[i].accul_trail_ind_vel) / V
             d1 = -rho * abs(Panel[i].gamma) * Panel[i].span * (Panel[i].accul_trail_ind_vel)
             d2 = Panel[i].l * np.sin(Panel[i].alpha_ind)
 
-            #print("%8.3f % 8.3f %8.3f" % (d0, d1, d2))
+            # print("%8.3f % 8.3f %8.3f" % (d0, d1, d2))
 
             Panel[i].d = d1
             Panel[i].cd = Panel[i].d / (q_inf * Panel[i].area)