From a94d126345e93636f94590115f6fe160191812f8 Mon Sep 17 00:00:00 2001
From: Alain Schubiger <alain.schubiger@ost.ch>
Date: Tue, 25 Jan 2022 10:03:40 +0100
Subject: [PATCH] added tree and some more info

---
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 46 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 1011e00..bb52cfb 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,40 @@
-# python-template
+# WEST Wind Energy Simulation Toolbox
+```
+├── LICENSE
+├── README.md
+├── config.yaml			(configuration file containing all simulation and site definitions)
+├── config_template.yaml
+├── data			(directory for input data e.g. measurements etc.)
+├── main.py			(main function to generate simulations)
+├── monitor_runs.py		(to monitor fluent runs on the hpc)
+├── post-aep.py  		(to calculate AEP)
+├── post-contourplots.py  	(to generate contour plots of velocity surface, e.g. wind speed at 100 m agl)
+├── post-fluent.py  		(to scale simulation data. Needs pre-measurements.py ewxecution before)
+├── pre-measurements.py  	(to clean and filter (per sector) measurements data )
+├── pre-siteplots.py		(to generate site specific plots, e.g. terrain, roughness)
+├── requirements.txt
+├── requirements_dev.txt
+├── scripts
+│	└── s_windrose.py	(script to generate wind rose figures from time series data)
+├── setup.py
+├── submit_to_hpc.py		(to submit simulations to local HPC infrastructure)
+├── tests
+│	├── test_raise.py
+│	└── test_sample.py
+└── west
+    ├── aep.py			(contains all aep related definitions)
+    ├── fluent.py		(contains all fluent related definitions)
+    ├── pointwisemesh.py	(contains all pointwise related definitions)
+    ├── post.py			(contains all post-processing related definitions)
+    ├── pre.py 			(contains all pre-processing related definitions)
+    ├── residuals.py	
+    └── utils.py		(contains various utility definitions)
+```
+
 
-To use this tool just clone the repository and install requirements.
+# Quickstart
+ **To use this tool just clone the repository and install requirements.**
 
-# quickstart
 1. prepare input 
 2. edit config.yaml
 3. run main.py
@@ -57,5 +89,15 @@ timestamp;v.avg.101;v.avg.100;v.avg.75;v.avg.50;v.avg.25;v.avg.10;v.std.101;v.st
 
 # FAQ / Troubleshoot
 
+- error at import data:
+	- check data format
+	- check CRS of data
+	- check domain definition (center, corners)
+	
+
 - main.py stops at meshing, error:
-check if Pointwise is installed and in PATH
\ No newline at end of file
+check if Pointwise is installed and in PATH
+
+
+- fluent crashes on 1 node:
+	- probably not enough RAM: increase number of nodes per simulation
-- 
GitLab