3_Expected_base_directory_structure.txt

Vandewalle, Kang, and Wang 2020

###############################################################
### Expected directory structures

The following directory structure is expected by many of the scripts. You can organize your own data structure differently, but may need to adjust some paths in files for it to work.

top_level_folder

 - batch
     jobscript.sh
     run_jobs.sh

 - fire_input
     santa_rosa_fire.cpg
     santa_rosa_fire.dbf
     santa_rosa_fire.prj
     santa_rosa_fire.qpj
     santa_rosa_fire.shp
     santa_rosa_fire.shx

  - getresults
     check_seeds.py
     collect_results_by_strat.py
     combine_results.py

  - households
     Santa_Rosa_tracts_hh.cpg
     Santa_Rosa_tracts_hh.dbf
     Santa_Rosa_tracts_hh.prj
     Santa_Rosa_tracts_hh.qpj
     Santa_Rosa_tracts_hh.shp
     Santa_Rosa_tracts_hh.shx

 combined_rslts_8_13.txt
 FireABM_opt.py
 FireABM_opt_Keel.py
 run_fireabm.py
 Sta_Rosa_2000.pkl
 Sta_Rosa_8000.pkl
 demo_road_graph.pkl
 FireABM_Demo_Notebook.ipynb
 Graph_Final_Summer_Results_Final.ipynb
 Rebuild_Road_Graphs.ipynb
 
### 
Here is an example structure for output data - this is more flexible. The collection scripts collect_results_by_strat.py and combine_results.py simply combine all files in a given folder, so it is useful to have a folder for results grouped by driving strategies (in this case, st_results) that is separate from a folder for final results from all strategies (combined_results). 

top_level_folder

 - combined_results
     combined_rslts_all_strategies.txt

 - st_results
     dist_results.txt 
     mjrd_results.txt
     quik_results.txt

 - majrds_output
    - 1files
    - 1trajs
    - 1videos

 - dist_output
    - 1files
    - 1trajs
    - 1videos

 - quik_output
    - 1files
    - 1trajs
    - 1videos