Merge branch 'master' of https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox

README.md

@@ -11,17 +11,17 @@ in [Hawc2io](wetb/hawc2/Hawc2io.py). These different implementations will be
 merged in due time.
 
 
-# Python 3
+# Works with Python 2 and Python 3
 
-This module currently only works under Python 3. If you are working in Python 2,
-this could be a good moment to consider switching. If you are bound to Python 2
-due to critical 3th party dependencies you are encouraged to cast your vote for
-Python 2 compatibility in
-[issue 1](https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox/issues/1).
+This module is tested for Python 2 and 3 compatibility, and works on both
+Windows and Linux. Testing for Mac is on the way, but in theory it should work.
+Python 2 and 3 compatibility is achieved with a single code base with the help
+of the Python module [future](http://python-future.org/index.html).
 
 Switching to Python 3 is in general a very good idea especially since Python 3.5
 was released. Some even dare to say it
 [is like eating your vegetables](http://nothingbutsnark.svbtle.com/porting-to-python-3-is-like-eating-your-vegetables).
+So if you are still on Python 2, we would recommend you to give Python 3 a try!
 
 You can automatically convert your code from Python 2 to 3 using the
 [2to3](https://docs.python.org/2/library/2to3.html) utility which is included
@@ -34,6 +34,8 @@ in Python 2.7 by default. You can also write code that is compatible with both
 
 * [numpy](http://www.numpy.org/)
 
+* [cython](http://cython.org/)
+
 * [scipy](http://scipy.org/scipylib/)
 
 * [pandas](http://pandas.pydata.org/)
@@ -48,9 +50,9 @@ in Python 2.7 by default. You can also write code that is compatible with both
 
 * [pyscaffold](http://pyscaffold.readthedocs.org/en/)
 
-* pytest
+* pytest, pytest-cov
 
-* six
+* six, [future](http://python-future.org/index.html)
 
 
 # Installation
@@ -112,7 +114,7 @@ General Time Series Data Format, a binary hdf5 data format for storing time seri
 - [bearing_damage](wetb/fatigue_tools/bearing_damage.py): Calculate a comparable measure of bearing damage
 
 ### [wind](wetb/wind)
-- [shear](wetb/wind/shear.py): Calculate and fit wind shear 
+- [shear](wetb/wind/shear.py): Calculate and fit wind shear
 
 ### [dlc](wetb/dlc)
 Module for working with "Design load cases" (Code independent)
@@ -125,6 +127,13 @@ corresponding execution scripts for a PBS Torque cluster (Linux), simple bash
 that calculates statistical parameters, performs rainflow counting for fatigue
 load calculations, and create load envelopes.
 
+Additional documentation can be found here:
+
+* [Auto-generation of Design Load Cases](docs/howto-make-dlcs.md)
+
+* [How to use the Statistics DataFrame](docs/using-statistics-df.md)
+
+
 ### [fast](wetb/fast)
 Tools for working with NREL's FAST code (An aeroelastic computer-aided engineering (CAE) tool for horizontal axis wind turbines)
 - [fast_io](wetb/fast/fast_io.py): Read binary and ascii result files

docs/install-manual-detailed.md

@@ -22,7 +22,14 @@ Installation instructions follow in alphabetical orderby platorm.
 install the following python dependencies:
 
 > numpy, cython, scipy, pandas, matplotlib, pyscaffold, future, nose, sphinx,
-> xlrd, pytables, h5py, pytest, pytest-cov, setuptools_scm, setuptools
+> xlrd, (py)tables, h5py, pytest, pytest-cov, setuptools_scm, setuptools
+
+Note that often the pytables packages is called python-tables instead of
+python-pytables.
+
+* Other tools you will need:
+
+> git gcc
 
 
 ## Mac
@@ -33,6 +40,11 @@ complete this guide :-)
 
 ## Windows
 
+A Python installation with compilers is required. If you already have this,
+or know how set up such an environment, you skip to
+[here](install-manual-detailed.md#and-finally-install-wetb).
+
+
 ### Microsft Visual Studio 2010
 
 
@@ -58,7 +70,10 @@ option if you know what you are doing or if you do not have administrative
 rights on your computer.
 
 * Git comes with a simple GUI, but there are more and different options available
-if you are not happy with it, see [here](https://git-scm.com/downloads/guis)
+if you are not happy with it, see [here](https://git-scm.com/downloads/guis).
+
+* If you would like to use a GUI for git, we recommend you to use
+[tortoisegit](https://tortoisegit.org/)
 
 
 ### Option 1: Anaconda (large download)
@@ -144,6 +159,9 @@ conda create -n py34 python=3.4
 activate py27
 ```
 
+
+### Install dependencies with conda and pip
+
 * Install the necessary Python dependencies using the conda package manager:
 
 ```