Merge pull request #67 from ggurioli/branch_setup

Minor revision of setup.py and of test_shaft.py

Author: mtezzele

README.md

@@ -46,13 +46,13 @@ See the [**Examples**](#examples) section below and the [**Tutorials**](tutorial
 
 ## Dependencies and installation
 **BladeX** requires `numpy`, `scipy`, `matplotlib`, `sphinx` (for the documentation), and `nose` (for the local test). They can be easily installed using `pip`. 
-**BladeX** is compatible with Python 2.7 and Python 3.6. Moreover, some of the modules require `OCC` to be installed for the `.iges` or `.stl` CAD generation. Please see the table below for instructions on how to satisfy the `OCC` requirements. You can also refer to `pythonocc.org` or `github.com/tpaviot/pythonocc-core` for further instructions.
+**BladeX** is compatible with Python 3.6. Moreover, some of the modules require `OCC` to be installed for the `.iges` or `.stl` CAD generation. This requirement cannot be satisfied through `pip`, but the precompiled binaries are available on `conda` using the command:
 
-| Package | Version     | How to install (precompiled binaries via conda)                                                                      |
-|---------|-------------|----------------------------------------------------------------------------------------------------------------------|
-| OCC     | ==0.18.1    | Python2.7 `conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 smesh=6.7.5 python=2.7` |
-| OCC     | ==0.18.1    | Python3.6 `conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 smesh=6.7.5 python=3.6` |
+```bash
+> conda install -c conda-forge pythonocc-core=7.4.0
+```
 
+You can also refer to `pythonocc.org` or `github.com/tpaviot/pythonocc-core` for further instructions.
 
 ### Installing from source
 The official distribution is on GitHub, and you can clone the repository using

bladex/__init__.py

@@ -3,6 +3,7 @@
 """
 __all__ = ['profilebase', 'profiles', 'blade', 'shaft', 'propeller', 'deform', 'params', 'ndinterpolator']
 
+from .meta import *
 from .profilebase import ProfileBase
 from .profiles import CustomProfile, NacaProfile
 from .blade import Blade

bladex/meta.py

@@ -0,0 +1,20 @@
+__all__ = [
+    '__project__',
+    '__title__',
+    '__author__',
+    '__copyright__',
+    '__license__',
+    '__version__',
+    '__mail__',
+    '__maintainer__',
+    '__status__']
+
+__project__ = 'BladeX'
+__title__ = "bladex"
+__author__ = "Marco Tezzele, Mahmoud Gadalla"
+__copyright__ = "Copyright 2019-2021, BladeX contributors"
+__license__ = "MIT"
+__version__ = "0.1.0"
+__mail__ = '[email protected], [email protected]'
+__maintainer__ = __author__
+__status__ = "Stable"

bladex/propeller.py

@@ -1,13 +1,9 @@
 """
 Module for the propeller with shaft bottom-up parametrized construction.
 """
-import os
 import numpy as np
-from bladex import Blade, Shaft
-import OCC.Core.TopoDS
-from OCC.Core.gp import gp_Dir, gp_Pnt, gp_Ax1, gp_Trsf
-from OCC.Core.IGESControl import IGESControl_Reader, IGESControl_Writer
-from OCC.Core.BRepBuilderAPI import BRepBuilderAPI_Transform, BRepBuilderAPI_Sewing
+from OCC.Core.IGESControl import IGESControl_Writer
+from OCC.Core.BRepBuilderAPI import BRepBuilderAPI_Sewing
 from OCC.Core.BRepAlgoAPI import BRepAlgoAPI_Fuse
 from OCC.Extend.DataExchange import write_stl_file
 from OCC.Display.SimpleGui import init_display
@@ -46,7 +42,6 @@ def __init__(self, shaft, blade, n_blades):
         boolean_union = BRepAlgoAPI_Fuse(self.shaft_solid, blades_combined)
         boolean_union.Build()
         result_compound = boolean_union.Shape()
-        section_edges = boolean_union.SectionEdges()
         sewer = BRepBuilderAPI_Sewing(1e-2)
         sewer.Add(result_compound)
         sewer.Perform()

bladex/shaft.py

@@ -13,6 +13,7 @@ class Shaft(object):
         stored shaft information.
     :cvar string filename: path (with the file extension) of a .stl or .iges file with 
         stored shaft information.
+    :raises Exception: if the extension in the filename is not in .stl or .iges formats.
     """
 
     def __init__(self, filename):
@@ -30,14 +31,14 @@ def generate_solid(self):
         """
         ext = os.path.splitext(self.filename)[1][1:]
         if ext == 'stl':
-        	shaft_compound = read_stl_file(self.filename)
+            shaft_compound = read_stl_file(self.filename)
         elif ext == 'iges':
-        	iges_reader = IGESControl_Reader()
-        	iges_reader.ReadFile(self.filename)
-        	iges_reader.TransferRoots()
-        	shaft_compound = iges_reader.Shape()
+            iges_reader = IGESControl_Reader()
+            iges_reader.ReadFile(self.filename)
+            iges_reader.TransferRoots()
+            shaft_compound = iges_reader.Shape()
         else:
-        	raise Exception('The shaft file is not in iges/stl formats')
+            raise Exception('The shaft file is not in iges/stl formats')
         sewer = BRepBuilderAPI_Sewing(1e-2)
         sewer.Add(shaft_compound)
         sewer.Perform()

setup.py

@@ -1,5 +1,23 @@
 from setuptools import setup
+import os
+import sys
 
+meta = {}
+with open("bladex/meta.py") as fp:
+    exec(fp.read(), meta)
+
+# Package meta-data.
+NAME = meta['__title__']
+DESCRIPTION = 'Python Blade Morphing'
+URL = 'https://github.com/mathLab/BladeX'
+MAIL = meta['__mail__']
+AUTHOR = meta['__author__']
+VERSION = meta['__version__']
+KEYWORDS='blade-generation propeller iges procal'
+
+REQUIRED = [
+    'numpy', 'scipy', 'matplotlib', 'Sphinx', 'sphinx_rtd_theme',
+]
 
 def readme():
     """
@@ -8,30 +26,26 @@ def readme():
     with open('README.md') as f:
         return f.read()
 
-
 setup(
-    name='bladex',
-    version='0.1.0',
-    description='BladeX.',
+    name=NAME,
+    version=VERSION,
+    description=DESCRIPTION,
     long_description=readme(),
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'License :: OSI Approved :: MIT License',
-        'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3.6',
         'Intended Audience :: Science/Research',
         'Topic :: Scientific/Engineering :: Mathematics'
     ],
-    keywords='blade-generation propeller iges procal',
-    url='https://github.com/mathLab/BladeX',
-    author='Marco Tezzele, Mahmoud Gadalla',
-    author_email='[email protected], [email protected]',
+    keywords=KEYWORDS,
+    url=URL,
+    author=AUTHOR,
+    author_email=MAIL,
     license='MIT',
-    packages=['bladex'],
-    install_requires=[
-        'numpy', 'scipy', 'matplotlib', 'Sphinx==1.4', 'sphinx_rtd_theme'
-    ],
+    packages=[NAME],
+    install_requires=REQUIRED,
     test_suite='nose.collector',
     tests_require=['nose'],
     include_package_data=True,
-    zip_safe=False)
+    zip_safe=False)

tests/test_package.py

@@ -33,23 +33,4 @@ def test_import_blade_4(self):
 
     def test_import_blade_5(self):
         import bladex as bx
-        inter = bx.ndinterpolator.RBF('gaussian_spline', 1.2)
-
-    def test_modules_name(self):
-        # it checks that __all__ includes all the .py files in bladex folder
-        import bladex
-        package = bladex
-
-        f_aux = []
-        for (__, __, filenames) in walk('bladex'):
-            f_aux.extend(filenames)
-
-        f = []
-        for i in f_aux:
-            file_name, file_ext = path.splitext(i)
-            if file_name != '__init__' and file_ext == '.py':
-                f.append(file_name)
-
-        print(f)
-        print(package.__all__)
-        assert sorted(package.__all__) == sorted(f)
+        inter = bx.ndinterpolator.RBF('gaussian_spline', 1.2)

tests/test_shaft.py

@@ -18,6 +18,11 @@ def test_generate_solid_02(self):
         shaft_solid = sh.generate_solid()
         self.assertIsInstance(shaft_solid, TopoDS_Solid)
 
+    def test_exception(self):
+    	sh = Shaft("tests/test_datasets/parameters.prm")
+    	with self.assertRaises(Exception):
+            sh.generate_solid()
+
     def test_display_01(self):
         sh = Shaft("tests/test_datasets/shaft.iges")
         sh.display()