adding max_hfx.m
[wrf-fire-matlab.git] / perimeter / readme_perim_witch.txt
blob0393427887c67f2de87181d52750ea585bbd778d
1 1) Finish this and submit;
2 2) Write Jan that it is related to his commit;
3 3) Write the comments for the perimeter_in code;
7 Volodymyr Kondratenko 8/7/2013
8 % This is the code that computes the level set function based on its given perimeter and 
9   time of ignitions of the points on the perimeter
11 1) Diretions about how to run the code;
12 2) Description of the input;
13 3) Description of the output;
15 (1) Please see the directions about how to run the code:
16    
17    A) If you are running the small/ideal case and there is no need to run
18       a job, then you:
19           - modify main_function.m (see how in (2))
20           - ln -s your wrfout file to the "perimeter" folder;
21           - run matlab and then run main_function.m
22    
23    B) If you are running a real case example and need to submit a job then:
25       1)  ln -s your wrfout file to the "perimeter" folder;
26       2)  You create a run2.m file in the folder wrf-fire/wrfv2_fire/test/em_fire,
27           that contains:
28           cd ../../../other/Matlab/perimeter/
29           main_function
31           3) You go back to the perimeter folder and modify main_function.m for your case;
32           4) qsub test_run.pbs;
34 (2) Description of the input:
35     
36         All the input variables lie in the main_funtion.m and you need to modify this
37         file according to your real case;
38     Description of the input variables:
39         1) data - empty if you are using tign_g from the wrfout to determine the
40            perimeter of the file, otherwise it contains time_now and coordinates 
41            of the perimeter of the fire;
42     2) wrfout='name of the wrfout file taht you are using', do not forget to 
43            ln -s the wrfout file to the perimeter folder;
44     3) interval- the length of each timestep in wrf-fire is 15min=900sec;
45            count- how many timesteps you jump over each iteration;
46            Example: each time_step in wrfout is 15minutes, thus interval=15*60=900sec;
47            You want to update every hour, so 60min=4*15, and so count=4;
48         4) time - the position of the time_now in the "Times" array in the wrfout file;
49         5) time_now - time of the fire perimeter;
51 (3) Description of the output:
52     Output will be printed to the output_tign.txt, that contains the tign of the 
53         area inside the fire_perimeter;
54         You can read it in matlab using dlmread:
55         tign=dlmread('output_tign.txt');