Merge branch 'master' of https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox

docs/getting-started-with-dlbs.md

@@ -102,10 +102,7 @@ $ source deactivate
 This will create a subfolders DLCs and fill that new subfolder with the created
 subordinate Excel files.
 
-##### 6. Move your DLCs.xlsx file from the htc folder to the ```_master``` folder.
-It will cause errors in later scripts if left in the htc folder.
-
-##### 7. Create your htc files and PBS job scripts .
+##### 6. Create your htc files and PBS job scripts .
 These files and scripts are generated from the subordinate Excel files from
 Step 5. To do this, in the terminal, change up a level to your Set ID folder
 (e.g., to folder "AB0001"). Then run this code
@@ -117,7 +114,7 @@ $ qsub-wrap.py -f /home/MET/repositories/toolbox/WindEnergyToolbox/wetb/prepost/
 Your htc files should now be placed in subfolders in the htc folder, and PBS
 job files should be in folder ```pbs_in```.
 
-##### 8. Launch the htc files to the cluster.
+##### 7. Launch the htc files to the cluster.
 Use the ```launch.py``` function to launch the jobs on the cluster.
 For example, the following code will launch the jobs in folder ```pbs_in``` on
 100 nodes. You must be in the top-level Set ID folder for this to work (e.g.,
@@ -136,7 +133,7 @@ help function to print available launch options:
 $ launch.py --help
 ```
 
-##### 9. Post-process results.
+##### 8. Post-process results.
 
 The wetb function ```qsub-wrap.py``` can not only generate htc files but also 
 post-process results. For example, here is code to check the log files

docs/tutorials/1-creating-master-excel.md

+# Tutorial 1: Creating master Excel file
+
+The Wind Energy Toolbox has a workflow for automatically running design load 
+bases (DLBs) on Gorm.
+This workflow has the following steps:
+1. Create a master Excel sheet defining each case in the DLB
+2. Create subordinate Excel sheets from each tab in the master Excel sheet
+3. Create htc files and PBS job scripts for each requisite simulation using 
+the subordinate Excel files and a master htc file.
+4. Submit all PBS job scripts to the cluster
+5. Post-process results
+6. Visualize results
+
+This tutorial presents how to accomplish Step 1.
+
+Note that it is possible to customize your simulations by skipping/modifying 
+steps.
+Such a procedure will be discussed in a later tutorial.
+
+If there are any problems with this tutorial, please [submit an issue](
+https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox/issues).
+
+## 1. Background: Master Excel File
+
+The master Excel file is an Excel file that is used to create subordinate 
+Excel files for generation of htc files and PBS job scripts.
+
+### Master file structure
+
+The master Excel file has a main tab, called "Main", that defines default 
+values  and necessary functions that are called in the other tabs.
+Each other tab defines a new case, and one subordinate Excel file will be 
+generated for each case.
+There are three variable types in the master Excel file:
+- Constants: values that do not change within a case
+- Variables: values that do change within a case, but are numbers that do not 
+depend on any other values (e.g., wind speed in DLC 1.2)
+- Functions: values that depend on other values
+
+### Tag names
+
+The values that are defined in the master Excel file (and eventually the 
+subordinate Excel files) are used to replace "tags" in the master htc file.
+These tags are of the form ```[$TAG_NAME]```.
+Theoretically, a user can define any new tags they desire, there are no 
+require naming conventions.
+However, there are some tags that are currently hard-coded into the Toolbox 
+that can result in errors if the tag names are changed.
+Thus, **we do not recommend you change the tag names from those in the 
+tutorial**.
+If you need new values that do not exist in the tutorial's master htc file 
+and produced master file, then it should be fine to add them.
+
+There are a few tags that deserve special mention:
+- ```[Case folder]```: the htc files for each case will be saved in this case 
+folder. We do not recommend changing the tag name or naming convention here 
+if you are doing a standard DLB.
+- ```[Case id.]```: this defines the naming convention for each htc file. We 
+do not recommend changing the tag name or naming convention here if you are 
+doing a standard DLB.
+- ```[seed]```: this variable indicates the desired number of seeds for each 
+set of variables. Thus, for example, in DLC 1.2, 1.3, the ```[seed]``` value 
+should be set to at least 6.
+
+Lastly, it is extremely important that your tag names in your master Excel 
+file match the tag names in your master htc file.
+Thus, **be sure to verify that your tag names in your master Excel and master 
+htc files are consistent**.
+
+## 2. Tutorial
+
+The procedure for creating the master Excel sheet is simple: each desired DLB 
+is defined in a tab-delimited text file, and these are loaded into a single 
+Excel file.
+It is assumed that the user has a collection of text files in a folder for 
+all of the DLBs to be simulated.
+This tutorial uses the text files located in 
+```wetb/docs/tutorials/data/DLCs_onshore```, which contain a series of text 
+files for a full DLB of an onshore turbine.
+These text files correspond to the onshore DTU 10 MW master htc file that is 
+located in the same directoy.
+
+Generate the master Excel file in a few easy steps:
+1. Open a command window.
+2. If you are running the tutorial locally (i.e., not on Gorm), navigate to 
+the Wind Energy Toolbox tutorials directory.
+3. From a terminal/command window, run the code to generate the Excel file 
+from a folder of text files:
+    * Windows:  
+    ```python ..\..\wetb\prepost\write_master.py --folder data\DLCs_onshore --filename DLCs_onshore.xlsx```
+    * Mac/Linux:  
+    ```python ../../wetb/prepost/write_master.py --folder data/DLCs_onshore  --filename DLCs_onshore.xlsx```
+    * Gorm:  
+    ```python  /home/MET/repositories/toolbox/WindEnergyToolbox/wetb/prepost/write_master.py --folder /home/MET/repositories/toolbox/WindEnergyToolbox/wetb/docs/tutoria
+ls/data/DLCs_onshore --filename DLCs_onshore.xlsx```
+ 
+The master Excel file "DLCs_onshore.xlsx" should now be in the your current 
+directory.
+
+Note that we have used the parser options ```--folder``` and ```--filename``` 
+to specify the folder with the text files and the name of the resulting Excel 
+file.
+Other parser options are also available.
+(See doc string in ```write_master.py``` function.)
+
+## 3. Generation options
+
+See doc string in ```write_master.py``` function.
+
+## 4. Issues
+
+If there are any problems with this tutorial, please [submit an issue](
+https://gitlab.windenergy.dtu.dk/toolbox/WindEnergyToolbox/issues).
+We will try to fix it as soon as possible.
+

docs/tutorials/data/DLCs_onshore/DLC12_IEC61400-1Ed3.txt

+C	F	V	V	V	F
+[Case folder]	[Case id.]	[wdir]	[seed]	[wsp]	[TI]
+DLC12_IEC61400-1Ed3	"""DLC12_wsp[wsp]_wdir[wdir]_s[seed]"""	0	6	4	"([ref_ti]*(0,75*[wsp]+5,6))/[wsp]"
+		350		6	
+		10		8	
+				10	
+				12	
+				14	
+				16	
+				18	
+				20	
+				22	
+				24	
+				26	
+					
+					
+					
+					
+					
+					
+					
+					
+					
+					
+					
+					

docs/tutorials/data/DLCs_onshore/DLC13_IEC61400-1Ed3.txt

+C	F	V	V	V	F
+[Case folder]	[Case id.]	[wdir]	[seed]	[wsp]	[TI]
+DLC13_IEC61400-1Ed3	"""DLC13_wsp[wsp]_wdir[wdir]_s[seed]"""	0	6	4	"2*[ref_ti]*(0,072*(0,2*[ref_wind_speed]/2+3)*([wsp]/2-4)+10)/[wsp]"
+		350		6	
+		10		8	
+				10	
+				12	
+				14	
+				16	
+				18	
+				20	
+				22	
+				24	
+				26	
+					
+					
+					
+					
+					
+					
+					
+					
+					
+					

docs/tutorials/data/DLCs_onshore/DLC14_IEC61400-1Ed3.txt

+C	C	F	V	V	C	C	F	C	C	C	C	F	C
+[sim_time]	[Case folder]	[Case id.]	[wdir]	[wsp]	[seed]	[turb_format]	[TI]	[gust]	[gust_type]	[G_A]	[G_t0]	[G_phi0]	[G_T]
+100	DLC14_IEC61400-1Ed3	"""DLC14_wsp[wsp]_wdir[wdir]_s[seed]"""	0	10	1	0	"2*[ref_ti]*(0,072*(0,2*[ref_wind_speed]/2+3)*([wsp]/2-4)+10)/[wsp]"		ecd	15	110	720/[wsp]	10
+				12									
+				14									

docs/tutorials/data/DLCs_onshore/DLC15_IEC61400-1Ed3.txt

+F	C	F	V	V	V	C	C	F	C	C	F	C	C
+[sim_time]	[Case folder]	[Case id.]	[wdir]	[G_phi0]	[wsp]	[seed]	[turb_format]	[TI]	[gust]	[gust_type]	[G_A]	[G_T]	[G_t0]
+100	DLC15_IEC61400-1Ed3	"""DLC15_wsp[wsp]_wdir[wdir]_s[seed]_phi[G_phi0]"""	0	0	4	1	0	"([ref_ti]*(0,75*[wsp]+5,6))/[wsp]"		ews	"(2,5+0,2*6,4*[TI]*[wsp]*([diameter]/[long_scale_param])**0,25)/[diameter]"	12	110
+				90	6								
+				180	8								
+				270	10								
+					12								
+					14								
+					16								
+					18								
+					20								
+					22								
+					24								
+					26								
+													
+													
+													
+													
+													
+													
+													
+													
+													
+													
+													
+													

docs/tutorials/data/DLCs_onshore/DLC21_IEC61400-1Ed3.txt

+F	C	F	V	V	V	F	C
+[sim_time]	[Case folder]	[Case id.]	[wdir]	[seed]	[wsp]	[TI]	[Grid loss time]
+100	DLC21_IEC61400-1Ed3	"""DLC21_wsp[wsp]_wdir[wdir]_s[seed]"""	0	4	4	"([ref_ti]*(0,75*[wsp]+5,6))/[wsp]"	110
+			350		6		
+			10		8		
+					10		
+					12		
+					14		
+					16		
+					18		
+					20		
+					22		
+					24		
+					26		
+							
+							
+							
+							
+							
+							
+							
+							
+							
+							
+							
+							

docs/tutorials/data/DLCs_onshore/DLC22b_IEC61400-1Ed3.txt

+C	F	V	V	V	F	C	C
+[Case folder]	[Case id.]	[wdir]	[seed]	[wsp]	[TI]	[Pitch 1 DLC22b]	[Time stuck DLC22b]
+DLC22b_IEC61400-1Ed3	"""DLC22b_wsp[wsp]_wdir[wdir]_s[seed]"""	0	12	4	"([ref_ti]*(0,75*[wsp]+5,6))/[wsp]"	0	0.1
+				6			
+				8			
+				10			
+				12			
+				14			
+				16			
+				18			
+				20			
+				22			
+				24			
+				26			
+							
+							
+							
+							
+							
+							
+							

docs/tutorials/data/DLCs_onshore/DLC22y_IEC61400-1Ed3.txt

+C	F	V	V	V	F	C		
+[Case folder]	[Case id.]	[wdir]	[seed]	[wsp]	[TI]	[dis_setbeta]		
+DLC22y_IEC61400-1Ed3	"""DLC22y_wsp[wsp]_wdir[wdir]_s[seed]"""	15	1	4	"([ref_ti]*(0,75*[wsp]+5,6))/[wsp]"	;		
+		30		6				
+		45		8				
+		60		10				
+		75		12				
+		90		14				
+		105		16				
+		120		18				
+		135		20				
+		150		22				
+		165		24				
+		180		26				
+		195						
+		210						
+		225						
+		240						
+		255						
+		270						
+		285						
+		300						
+		315						
+		330						
+		345						

docs/tutorials/data/DLCs_onshore/DLC23_IEC61400-1Ed3.txt

+F	C	F	V	V	C	C	F	C	C	F	C	C	C	F
+[sim_time]	[Case folder]	[Case id.]	[wsp]	[Grid loss time]	[seed]	[turb_format]	[TI]	[gust]	[gust_type]	[G_A]	[G_phi0]	[G_T]	[G_t0]	[grid_gust_delay]
+100	DLC23_IEC61400-1Ed3	"""DLC23_wsp[wsp]_wdir[wdir]_s[seed]_tgl[grid_gust_delay]"""	10	122.5	1	0	"([ref_ti]*(0,75*[wsp]+5,6))/[wsp]"		eog	"min([1,35*(0,8*1,4*[ref_wind_speed]-[wsp]);3,3*[TI]*[wsp]/(1+0,1*[diameter]/[long_scale_param])])"	0	10.5	120	([Grid loss time]-[G_t0])*10
+			14	124										
+			26	125.25								 		

docs/tutorials/data/DLCs_onshore/DLC24_IEC61400-1Ed3.txt

+C	F	V	V	V	C	F				
+[Case folder]	[Case id.]	[wdir]	[seed]	[wsp]	[turb_format]	[TI]				
+DLC24_IEC61400-1Ed3	"""DLC24_wsp[wsp]_wdir[wdir]_s[seed]"""	340	3	4	1	"([ref_ti]*(0,75*[wsp]+5,6))/[wsp]"				
+		20		6						
+				8						
+				10						
+				12						
+				14						
+				16						
+				18						
+				20						
+				22						
+				24						
+				26						
+										
+										
+										
+										
+										
+										
+										
+										
+										

docs/tutorials/data/DLCs_onshore/DLC31_IEC61400-1Ed3.txt

+F	C	F	V	C	C	C	C
+[sim_time]	[Case folder]	[Case id.]	[wsp]	[seed]	[turb_format]	[TI]	[cutin_t0]
+250	DLC31_IEC61400-1Ed3	"""DLC31_wsp[wsp]_wdir[wdir]_s[seed]"""	4	1	0	0.0000	110
+			12				
+			25				

docs/tutorials/data/DLCs_onshore/DLC32_IEC61400-1Ed3.txt

+F	C	F	V	C	C	F	C	C	F	C	F	C	V	F
+[sim_time]	[Case folder]	[Case id.]	[wsp]	[seed]	[turb_format]	[TI]	[gust]	[gust_type]	[G_A]	[G_phi0]	[G_t0]	[G_T]	[cutin_t0]	[grid_gust_delay]
+200	DLC32_IEC61400-1Ed3	"""DLC32_wsp[wsp]_wdir[wdir]_s[seed]_tci[grid_gust_delay]"""	4	1	0	"([ref_ti]*(0,75*[wsp]+5,6))/[wsp]"		eog	"min([1,35*(0,8*1,4*[ref_wind_speed]-[wsp]);3,3*[TI]*[wsp]/(1+0,1*[diameter]/[long_scale_param])])"	0	[wsp]/(0.01813228 *[wsp] - 0.04811716)	10.5	50.1	([cutin_t0]-[G_t0])*10
+			10										52.5	
+			14										54	
+			26										55.25	

docs/tutorials/data/DLCs_onshore/DLC41_IEC61400-1Ed3.txt

+F	C	F	V	C	C	C	C
+[sim_time]	[Case folder]	[Case id.]	[wsp]	[seed]	[turb_format]	[TI]	[Cut-out time]
+100	DLC41_IEC61400-1Ed3	"""DLC41_wsp[wsp]_wdir[wdir]_s[seed]"""	4	1	0	0	110
+			12				
+			26				

docs/tutorials/data/DLCs_onshore/DLC42_IEC61400-1Ed3.txt

+F	C	F	V	C	C	F	C	C	F	C	C	C	V	F
+[sim_time]	[Case folder]	[Case id.]	[wsp]	[seed]	[turb_format]	[TI]	[gust]	[gust_type]	[G_A]	[G_phi0]	[G_t0]	[G_T]	[Cut-out time]	[grid_gust_delay]
+100	DLC42_IEC61400-1Ed3	"""DLC42_wsp[wsp]_wdir[wdir]_s[seed]_tco[grid_gust_delay]"""	10	1	0	"([ref_ti]*(0,75*[wsp]+5,6))/[wsp]"		eog	"min([1,35*(0,8*1,4*[ref_wind_speed]-[wsp]);3,3*[TI]*[wsp]/(1+0,1*[diameter]/[long_scale_param])])"	0	120	10.5	120.1	([Cut-out time]-[G_t0])
+			14										122.5	
+			26										124	
+													125	
+													128	
+													130	

docs/tutorials/data/DLCs_onshore/DLC51_IEC61400-1Ed3.txt

+F	C	F	V	V	V	C	F	C	C
+[sim_time]	[Case folder]	[Case id.]	[wdir]	[seed]	[wsp]	[turb_format]	[TI]	[Cut-out time]	[Stop type]
+100	DLC51_IEC61400-1Ed3	"""DLC51_wsp[wsp]_wdir[wdir]_s[seed]"""	0	12	10	1	"([ref_ti]*(0,75*[wsp]+5,6))/[wsp]"	110	2
+					12				
+					14				

docs/tutorials/data/DLCs_onshore/DLC61_IEC61400-1Ed3.txt

+C	F	V	V	V	C	C	C	C	C
+[Case folder]	[Case id.]	[wdir]	[seed]	[wsp]	[turb_format]	[TI]	[shear_exp]	[cutin_t0]	[Induction]
+DLC61_IEC61400-1Ed3	"""DLC61_wsp[wsp]_wdir[wdir]_s[seed]"""	352	6	50	1	0.1100	0.11	1000	0
+		8							

docs/tutorials/data/DLCs_onshore/DLC62_IEC61400-1Ed3.txt

+C	F	V	V	V	C	C	C	C	C	C
+[Case folder]	[Case id.]	[wsp]	[wdir]	[seed]	[turb_format]	[TI]	[shear_exp]	[cutin_t0]	[Induction]	[dis_setbeta]
+DLC62_IEC61400-1Ed3	"""DLC62_wsp[wsp]_wdir[wdir]_s[seed]"""	50	0	1	1	0.1100	0.11	1000	0	;
+			15							
+			30							
+			45							
+			60							
+			75							
+			90							
+			105							
+			120							
+			135							
+			150							
+			165							
+			180							
+			195							
+			210							
+			225							
+			240							
+			255							
+			270							
+			285							
+			300							
+			315							
+			330							
+			345							

docs/tutorials/data/DLCs_onshore/DLC63_IEC61400-1Ed3.txt

+C	F	V	V	V	C	C	C	C	C
+[Case folder]	[Case id.]	[wdir]	[seed]	[wsp]	[turb_format]	[TI]	[shear_exp]	[cutin_t0]	[Induction]
+DLC63_IEC61400-1Ed3	"""DLC63_wsp[wsp]_wdir[wdir]_s[seed]"""	340	6	40	1	0.1100	0.11	1000	0
+		20							

docs/tutorials/data/DLCs_onshore/DLC64_IEC61400-1Ed3.txt

+C	F	V	V	V	C	F	C	C
+[Case folder]	[Case id.]	[wdir]	[seed]	[wsp]	[turb_format]	[TI]	[cutin_t0]	[Induction]
+DLC64_IEC61400-1Ed3	"""DLC64_wsp[wsp]_wdir[wdir]_s[seed]"""	352	6	4	1	"([ref_ti]*(0,75*[wsp]+5,6))/[wsp]"	1000	0
+		8		6				
+				8				
+				10				
+				12				
+				14				
+				16				
+				18				
+				20				
+				22				
+				24				
+				26				
+				28				
+				30				
+				32				
+				34				
+								
+								
+								
+								
+