Merge branch 'master' of https://github.com/mihasm/Python-BEM

Author: Miha Smrekar

README.md

@@ -1,15 +1,13 @@
-## README
+# About the software
 
-## About the software
-
-# What is it for?
+## What is it for?
 Wind turbines and propellers involve relatively complex geometries, and due to the rotation of the turbine, movement of the air, and the fact that lift is a function of the shape of each blade, it is hard to calculate the forces, power and efficiency of such systems by hand.
 
 Methods for determining the parameters of such turbines were in the past mainly experimental, and nowadays relatively accurate calculations can be made using 3D computational fluid dynamics calculations. The main disadvantages to such methods are the cost, and time involved in preparation, calculation, and post-calculation analysis.
 
 In order for a turbine designer to quickly generate a geometry and determine the forces and other parameters of a turbine, a fast, cost-effective way is to use the blade element momentum theory.
 
-# Blade element momentum theory
+## Blade element momentum theory
 
 Blade Element Momentum theory software (BEM) is a tool for calculating the local forces on a propeller or wind turbine using the blade element momentum theory. The calculation is based on the Rankine-Froude momentum theory and the blade element theory.
 
@@ -30,7 +28,7 @@ b. the total power, torque and efficiency
 c. (optionally) statical analysis
 d. other parameters
 
-# Similar software
+## Similar software
 
 Software that fulfill a similar role, and were an inspiration to the development of this software, include:
 QBlade, Aerodyn, XFOIL, etc.
@@ -39,19 +37,19 @@ There are many custom BEM-based applications that turbine and propeller manufact
 
 ## How to use the software
 
-# Main window
+### Main window
 
 The BEM software main window is divided into multiple tabs, which are divided by their corresponding function, these are: Airfoil management, Turbine info, Analysis and Optimization. The analysis is started on the Analyiss tab and after it is finished, an Results window is finally opened, from which results can be checked on and exported, as necessary.
 
-# Airfoil management
+### Airfoil management
 
 In the Airfoil management tab, a designer can:
 	a. Add, rename, duplicate, remove, load and save airfoil data
 	b. import airfoil data
 	c. import or calculate the cL/cD curves of an airfoil
 	d. create 360° cL/cD curves using Montgomerie methods
 
-# Turbine info
+### Turbine info
 
 In the Turbine info tab, a designer can:
 	a. Set up the basic turbine data (name, radii, number of blades, etc.)
@@ -61,18 +59,20 @@ In the Turbine info tab, a designer can:
 	e. Export the geometry to Solidworks
 	f. Create standard geometry graphs for distribution and documentation purposes
 
-# Analysis
+### Analysis
 
 In the Analysis tab, a designer can:
 	a. Determine the basic calculation parameters
 	b. Run the analysis, which will, after finishing, open the results window
 
-# Optimization
+### Optimization
 
 In the Optimization tab, the designer can optimize the geometry using an optimization algorithm in order to ensure that the geometry is optimized to a specific fluid speed/rotational velocity combination. The parameters that will be modified are called input parameters, and the parameters that will determine the success of the optimization (optimization function) are called the output variables. Target variables are also supported, in case one desires not the largest torque, power, or other parameter, but instead a specific torque, power or other parameter.
 
 The optimization GUI is still in developement.
 
+# Installation and usage
+
 ## Supported Python version
 3.2<3.9
 
@@ -86,4 +86,4 @@ python main.py
 pyinstaller main.spec
 
 ## On Mac - to run xfoil
-brew install xquartz
+brew install xquartz