Skip to content
Snippets Groups Projects
Commit a9cbb892 authored by David Verelst's avatar David Verelst
Browse files

updated README: py23 compatible, link to prepost docs

parent 66f4ff74
No related branches found
No related tags found
No related merge requests found
...@@ -11,17 +11,17 @@ in [Hawc2io](wetb/hawc2/Hawc2io.py). These different implementations will be ...@@ -11,17 +11,17 @@ in [Hawc2io](wetb/hawc2/Hawc2io.py). These different implementations will be
merged in due time. 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 module is tested for Python 2 and 3 compatibility, and works on both
this could be a good moment to consider switching. If you are bound to Python 2 Windows and Linux. Testing for Mac is on the way, but in theory it should work.
due to critical 3th party dependencies you are encouraged to cast your vote for Python 2 and 3 compatibility is achieved with a single code base with the help
Python 2 compatibility in of the Python module [future](http://python-future.org/index.html).
[issue 1](https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox/issues/1).
Switching to Python 3 is in general a very good idea especially since Python 3.5 Switching to Python 3 is in general a very good idea especially since Python 3.5
was released. Some even dare to say it 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). [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 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 [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 ...@@ -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/) * [numpy](http://www.numpy.org/)
* [cython](http://cython.org/)
* [scipy](http://scipy.org/scipylib/) * [scipy](http://scipy.org/scipylib/)
* [pandas](http://pandas.pydata.org/) * [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 ...@@ -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/) * [pyscaffold](http://pyscaffold.readthedocs.org/en/)
* pytest * pytest, pytest-cov
* six * six, [future](http://python-future.org/index.html)
# Installation # Installation
...@@ -112,7 +114,7 @@ General Time Series Data Format, a binary hdf5 data format for storing time seri ...@@ -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 - [bearing_damage](wetb/fatigue_tools/bearing_damage.py): Calculate a comparable measure of bearing damage
### [wind](wetb/wind) ### [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) ### [dlc](wetb/dlc)
Module for working with "Design load cases" (Code independent) Module for working with "Design load cases" (Code independent)
...@@ -125,6 +127,13 @@ corresponding execution scripts for a PBS Torque cluster (Linux), simple bash ...@@ -125,6 +127,13 @@ corresponding execution scripts for a PBS Torque cluster (Linux), simple bash
that calculates statistical parameters, performs rainflow counting for fatigue that calculates statistical parameters, performs rainflow counting for fatigue
load calculations, and create load envelopes. 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) ### [fast](wetb/fast)
Tools for working with NREL's FAST code (An aeroelastic computer-aided engineering (CAE) tool for horizontal axis wind turbines) 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 - [fast_io](wetb/fast/fast_io.py): Read binary and ascii result files
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment