diff --git a/README.md b/README.md index 2e6318326a8ccf1d665499feb609ff8b74dc62e5..2bdaedc8b3f30c48c5a7872576608387462bbe85 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/. + diff --git a/docs/install-manual-detailed.md b/docs/install-manual-detailed.md new file mode 100644 index 0000000000000000000000000000000000000000..692104c3e3af9521aacf4f1eb3b05ae4649623a5 --- /dev/null +++ b/docs/install-manual-detailed.md @@ -0,0 +1,34 @@ + +!! This guide is not finished yet, it is a WIP (Work In Progress) !! + +# Detailed Installation Manual + +Installing Python packages with compiled extensions can be a challenge especially +on Windows systems. However, when using Miniconda things can be simplified to a +great extent as this manual hopefully will show you. + +The this approach will require you to use the command line, but it is as easy +as copy-pasting them from this page straight into your command prompt. + + +## Using Miniconda + +* Download the latest Python 3 (!!) Miniconda installer for your platform +[here](http://conda.pydata.org/miniconda.html) + +* No need to worry about Python 2 or 3 at this stage. You can still use the +Python 3 installer for creating Python 2 conda environments + +* Install the necessary Python dependencies using the conda package manager: + +``` +conda install scipy pandas matplotlib cython xlrd pytables sphinx mingw +``` + +* Not all packages are available in the conda repositories, but they can be +easily installed with pip: + +``` +pip install pyscaffold pytest pytest-cov +``` +