Merge pull request #32 from mtezzele/doc

Doc

Author: mtezzele

README.md

@@ -1,5 +1,3 @@
-**BladeX**: Python Package for Blade Deformation
-
 <p align="center">
   <a href="http://mathlab.github.io/BladeX/" target="_blank" >
     <img alt="Python Package for Blade Deformation" src="docs/source/_static/logo_bladex.png" width="200" />

docs/source/_tutorials/pictures/transformations.png

@@ -11780,7 +11780,7 @@ <h2 id="Tutorial-3:-Prepare-a-blade-3D-sectional-profiles">Tutorial 3: Prepare a
 <div class="inner_cell">
 <div class="text_cell_render border-box-sizing rendered_html">
 <p>The foil transformations according to the pitch, rake, and skew are all given in the following transformations map.</p>
-<p><img src="data/transformations.png"></p>
+<p><img src="pictures/transformations.png" alt=""></p>
 
 </div>
 </div>

docs/source/_tutorials/tutorial3generateblade.html

@@ -70,7 +70,7 @@
 
 # General information about the project.
 project = u'BladeX'
-copyright = u'2018, BladeX contributors'
+copyright = u'2018-2019, BladeX contributors'
 author = u'BladeX contributors'
 
 # autoclass
@@ -81,7 +81,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.0.1'
+version = '0.1'
 # The full version, including alpha/beta/rc tags.
 release = version
 

docs/source/conf.py

@@ -1,15 +1,32 @@
 Welcome to BladeX's documentation!
 ===================================================
 
+.. image:: _static/logo_bladex.png
+   :height: 150px
+   :width: 150 px
+   :align: right
+
 Description
 ^^^^^^^^^^^^
 
-BladeX is a Python package for blade generation.
+BladeX is a Python package for geometrical parametrization and bottom-up construction of propeller blades. It allows to generate and deform a blade based on the radial distribution of its parameters such as pitch, rake, skew, and the sectional foils' parameters such as chord and camber. The package is ideally suited for parametric simulations on large number of blade deformations. It provides an automated procedure for the CAD generation, hence reducing the time and effort required for modelling. The main scope of BladeX is to deal with propeller blades, however it can be flexible to be applied on further applications with analogous geometrical structures such as aircraft wings, turbomachinery, or wind turbine blades.
+
+
+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 below for instructions on how to satisfy the OCC requirements. You can also refer to `pythonocc.org <https://pythonocc.org>`_ or `github.com/tpaviot/pythonocc-core <https://github.com/tpaviot/pythonocc-core>`_ for further instructions. 
 
+Python2.7 OCC installation:
+::
+
+  conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 python=2.7
+
+Python3.6 OCC installation:
+::
 
-Installation
---------------------
-BladeX requires numpy, scipy, matplotlib, and sphinx (for the documentation). They can be easily installed via pip. 
+  conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 python=3.6
 
 
 The `official distribution <https://github.com/mathLab/BladeX>`_ is on GitHub, and you can clone the repository using
@@ -31,7 +48,7 @@ To uninstall the package you have to rerun the installation and record the insta
 
 
 Tutorials
---------------------
+^^^^^^^^^^^^^^^^
 
 We made some tutorial examples. Please refer to the official GitHub repository for the last updates. Here the list of the exported tutorials:
 
@@ -42,7 +59,7 @@ We made some tutorial examples. Please refer to the official GitHub repository f
 
 
 Developer's Guide
---------------------
+^^^^^^^^^^^^^^^^^^^^^^^
 
 .. toctree::
    :maxdepth: 1

docs/source/index.rst

@@ -11,18 +11,18 @@ def readme():
 
 setup(
     name='bladex',
-    version='0.0.1',
+    version='0.1.0',
     description='BladeX.',
     long_description=readme(),
     classifiers=[
-        'Development Status :: 0 - Alpha',
+        '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',
+    keywords='blade-generation propeller iges procal',
     url='https://github.com/mathLab/BladeX',
     author='Marco Tezzele, Mahmoud Gadalla',
     author_email='[email protected], [email protected]',