From a76b2eeea527638c9cc57d7038c8db0a2c50e4d8 Mon Sep 17 00:00:00 2001 From: dave <dave@dtu.dk> Date: Fri, 25 Nov 2016 11:39:07 +0100 Subject: [PATCH] updating/refactoring docs and how-to's --- README.md | 111 ++-------------------------------------- docs/howto-make-dlcs.md | 14 +++++ docs/install.md | 79 ++++++++++++++++++++++++++++ 3 files changed, 98 insertions(+), 106 deletions(-) create mode 100644 docs/install.md diff --git a/README.md b/README.md index f019bc54..298d5aee 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ [](https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox/commits/master) [](https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox/commits/master) + # Introduction The Wind Energy Toolbox (or ```wetb```, pronounce as wee-tee-bee) is a collection @@ -12,103 +13,7 @@ some of the functions in the [prepost](#prepost) module have a similar functions in [Hawc2io](wetb/hawc2/Hawc2io.py). These different implementations will be merged in due time. - -# How to create HAWC2 DLB's and run them on a cluster - -The process of how to generated, run and post-process a design load basis (DLB) -of HAWC2 simulations on a DTU Wind Energy cluster is outlined in more detail -in the documentation: - -* [Auto-generation of Design Load Cases](docs/howto-make-dlcs.md) -* [House rules mimer/hawc2sim and HAWC2 folder structure](docs/houserules-mimerhawc2sim.md) -* [Generate DLB spreadsheets](docs/generate-spreadsheet.md) -* [How to use the Statistics DataFrame](docs/using-statistics-df.md) - -You can also use the Pdap for post-processing, which includes a MS Word report -generator based on a full DLB, a GUI for easy plotting of HAWC2 result files, -and a Python scripting interface: - -* [Pdap](http://www.hawc2.dk/Download/Post-processing-tools/Pdap) -* [Pdap report/docs](http://orbit.dtu.dk/en/publications/post-processing-of-design-load-cases-using-pdap%28827c432b-cf7d-44eb-899b-93e9c0648ca5%29.html) - - -# Works with Python 2 and Python 3 - -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 -in Python 2.7 by default. You can also write code that is compatible with both -2 and 3 at the same time (you can find additional resources in -[issue 1](https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox/issues/1)). - - -# Dependencies - -* [numpy](http://www.numpy.org/) - -* [cython](http://cython.org/) - -* [scipy](http://scipy.org/scipylib/) - -* [pandas](http://pandas.pydata.org/) - -* xlrd and xlwt from [python-excel](http://www.python-excel.org/) - -* [openpyxl](http://openpyxl.readthedocs.org/en/default/) - -* h5py - -* [matplotlib](http://matplotlib.org/) - -* [pytables](http://www.pytables.org/) - -* [pyscaffold](http://pyscaffold.readthedocs.org/en/) - -* pytest, pytest-cov - -* six, [future](http://python-future.org/index.html) - - -# 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 know what you are doing, you can install as a package as follows: - -``` -python setup.py install -``` - -Or in development mode, install from your working directory - -``` -pip install -e ./ -``` - - -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 -forthcoming. - +Both Python2 and Python3 are supported. # Contents of WindEnergyToolbox, [wetb](wetb) @@ -159,9 +64,9 @@ 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) +- [Auto-generation of Design Load Cases](docs/howto-make-dlcs.md) +- [How to use the Statistics DataFrame](docs/using-statistics-df.md) +- [Generate DLB spreadsheets](docs/generate-spreadsheet.md) ### [fast](wetb/fast) @@ -175,9 +80,3 @@ 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/howto-make-dlcs.md b/docs/howto-make-dlcs.md index 8720fde3..6985059c 100644 --- a/docs/howto-make-dlcs.md +++ b/docs/howto-make-dlcs.md @@ -55,6 +55,17 @@ line starts with ```g-000 $```. The command that needs to be entered starts after the ```$```. +Pdap +---- + +You can also use the Pdap for post-processing, which includes a MS Word report +generator based on a full DLB, a GUI for easy plotting of HAWC2 result files, +and a Python scripting interface: + +* [Pdap](http://www.hawc2.dk/Download/Post-processing-tools/Pdap) +* [Pdap report/docs](http://orbit.dtu.dk/en/publications/post-processing-of-design-load-cases-using-pdap%28827c432b-cf7d-44eb-899b-93e9c0648ca5%29.html) + + Connecting to the cluster ------------------------- @@ -235,6 +246,9 @@ from here (valid for the DTU10MW): /mnt/mimer/hawc2sim/DTU10MW/C0020/htc/DLCs ``` +Note that ```dlctemplate.py``` does not require any changes or modifications +if you are only interested in running the standard DLB as explained here. + For example, in order to generate all the HAWC2 htc input files and the corresponding ```*.p``` cluster launch files using this default DLB setup with: diff --git a/docs/install.md b/docs/install.md new file mode 100644 index 00000000..dfd9151c --- /dev/null +++ b/docs/install.md @@ -0,0 +1,79 @@ +# 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 know what you are doing, you can install as a package as follows: + +``` +python setup.py install +``` + +Or in development mode, install from your working directory + +``` +pip install -e ./ +``` + + +Or create a binary wheel distribution package with: + +``` +python setup.py bdist_wheel -d dist +``` + + + +## Works with Python 2 and Python 3 + +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 +in Python 2.7 by default. You can also write code that is compatible with both +2 and 3 at the same time (you can find additional resources in +[issue 1](https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox/issues/1)). + + + +## Dependencies + +* [numpy](http://www.numpy.org/) + +* [cython](http://cython.org/) + +* [scipy](http://scipy.org/scipylib/) + +* [pandas](http://pandas.pydata.org/) + +* xlrd and xlwt from [python-excel](http://www.python-excel.org/) + +* [openpyxl](http://openpyxl.readthedocs.org/en/default/) + +* h5py + +* [matplotlib](http://matplotlib.org/) + +* [pytables](http://www.pytables.org/) + +* [pyscaffold](http://pyscaffold.readthedocs.org/en/) + +* pytest, pytest-cov + +* six, [future](http://python-future.org/index.html) + + +## Note + +This project has been set up using PyScaffold 2.5. For details and usage +information on PyScaffold see http://pyscaffold.readthedocs.org/. + -- GitLab