From 5cf5c5aba93627254084bcd2fa7eb14697325c40 Mon Sep 17 00:00:00 2001
From: dave <dave@dtu.dk>
Date: Wed, 13 Apr 2016 10:27:16 +0200
Subject: [PATCH] updated docs
---
README.md | 19 +++++++++++++++++++
docs/houserules-mimerhawc2sim.md | 5 +++--
docs/install-manual-detailed.md | 2 +-
3 files changed, 23 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index ddb6591..7760d2a 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,25 @@ 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
diff --git a/docs/houserules-mimerhawc2sim.md b/docs/houserules-mimerhawc2sim.md
index e610558..6b5e2e9 100644
--- a/docs/houserules-mimerhawc2sim.md
+++ b/docs/houserules-mimerhawc2sim.md
@@ -1,6 +1,6 @@
-House Rules for ```mimer/hawc2sim```
-====================================
+House Rules for ```mimer/hawc2sim``` and HAWC2 model folder structure
+=====================================================================
Objectives
@@ -32,6 +32,7 @@ The HAWC2 simulations are located on the data capacitor [mimer]
The following structure is currently used for this ```hawc2sim``` directory:
* turbine model (e.g. DTU10MW, NREL5MW, etc)
* set ID: 2 alphabetic characters followed by 4 numbers (e.g. AA0001)
+* letters are task/project oriented, numbers are case oriented
For example:
* DTU10MW
diff --git a/docs/install-manual-detailed.md b/docs/install-manual-detailed.md
index c88d04f..aa2216a 100644
--- a/docs/install-manual-detailed.md
+++ b/docs/install-manual-detailed.md
@@ -1,5 +1,5 @@
-!! This guide is not finished, and might contain innacuracies. Please report
+> !! This guide is not finished, and might contain innacuracies. Please report
any mistakes/bugs by creating an
[issue](https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox/issues).
This is a WIP (Work In Progress) !!
--
GitLab