From 8e05cf03bdd931dd2b7b716887d455b8a523372b Mon Sep 17 00:00:00 2001 From: dave <dave@dtu.dk> Date: Fri, 29 Jan 2016 11:24:45 +0100 Subject: [PATCH] updated readme (dependencies, installation) --- README.md | 47 ++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 40 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2e63183..2bdaedc 100644 --- a/README.md +++ b/README.md @@ -32,20 +32,46 @@ in Python 2.7 by default. You can also write code that is compatible with both # Dependencies -[numpy](http://www.numpy.org/) -[scipy](http://scipy.org/scipylib/) -[pandas](http://pandas.pydata.org/) -[matplotlib](http://matplotlib.org/) -[pytables](http://www.pytables.org/) -[pyscaffold](http://pyscaffold.readthedocs.org/en/) +* [numpy](http://www.numpy.org/) + +* [scipy](http://scipy.org/scipylib/) + +* [pandas](http://pandas.pydata.org/) + +* xlrd + +* h5py + +* [matplotlib](http://matplotlib.org/) + +* [pytables](http://www.pytables.org/) + +* [pyscaffold](http://pyscaffold.readthedocs.org/en/) + +* pytest + +* six # Installation +Detailed installation instructions, including how to install Python from scratch, +are described in the [detailed installation manual](docs/install-manual-detailed.md). + + +If you now what you are doing, you can install as follows: + ``` python setup.py ``` +Or create a binary wheel distribution package with: + +``` +python setup.py bdist_wheel -d dist +``` + + # Tests Only a small part of the code is covered by unittests currently. More tests are @@ -54,6 +80,8 @@ forthcoming. # Contents of WindEnergyToolbox, [wetb](wetb) +### Overview + - [hawc2](#hawc2) - [gtsdf](#gtsdf) - [fatigue_tools](#fatigue_tools) @@ -63,7 +91,6 @@ forthcoming. - [fast](#fast) - [utils](#utils) ------------------------------------------------------------------------------------- ### [hawc2](wetb/hawc2) - [Hawc2io](wetb/hawc2/Hawc2io.py): Read binary, ascii and flex result files - [sel_file](wetb/hawc2/sel_file.py): Read/write *.sel (sensor list) files @@ -109,3 +136,9 @@ Other functions - [timing](wetb/utils/timing.py): Decorators for evaluating execution time of functions - [caching](wetb/utils/caching.py): Decorators to create cached (calculate once) functions and properties + +# Note + +This project has been set up using PyScaffold 2.5. For details and usage +information on PyScaffold see http://pyscaffold.readthedocs.org/. + -- GitLab