README.md

   1 # JPPSdata
   2 ### Usage Support Vector Machine:
   3
   4 ### Usage L2 minimization:
   5 1) Run case.py as:
   6
   7         $ python case.py wrfout start_time days
   8
   9         Generates the fire mesh, downloads all the granules in between the dates and intersecting with the fire mesh, reads all the important information inside them and saves everything in a text file called 'data'. It creates as well a csv file and a KML file with all the detections called 'fire_detections.csv' and 'fire_detections.kml'. It is also created a KML file with the ground detections called 'nofire.kml'. The input variales are:
  10
  11         - wrfout:  string, link to the wrfout file of WRF-SFIRE simulation.
  12         - start_time - string, YYYYMMDDHHMMSS where:
  13                 - YYYY - year
  14                 - MM - month
  15                 - DD - day
  16                 - HH - hour
  17                 - MM - minute
  18                 - SS - second
  19         - days: integer, number of days of simulation.
  20
  21 2) Run setup.py as:
  22
  23         $ python setup.py
  24
  25         Processes all the granules and creates the upper and lower bounds for the fire arrival time. It saves everything in a text file called 'result' and in a Matlab file called 'result.mat'.
  26
  27 5) The Matlab file result.mat can be used to run the Multigrid method which are going to define a fire arrival time curve in between the upper and lower bounds as a rigid plate deformed by forces. In order to do that, the next steps are necessary.
  28
  29 6) Link the Matlab file 'result.mat' into the private fire_interpolation repository in:
  30
  31         ssh://repo.openwfm.org/home/git/fire_interpolation
  32
  33 7) Run in Matlab the script jpss_mg.m as:
  34
  35         \>\> jpss_mg
  36
  37         Generates the fire arrival time in a 2D array called 'a' using the Multigrid technique and saves everything in a Matlab file called 'mgout.mat'. It shows in different figures the different levels and how they are changing all the time.
  38
  39 8) Link back the Matlab file 'mgout.mat' into the JPSSData repository and run contline.py as:
  40
  41         $ python contline.py
  42
  43         Generates a contour line representation of the results in a KML file called 'perimeters.kml'. It can be opened in Google Earth application as well with step 2) and it generates a movie of the interpolation with the fire detections.
  44
  45 https://github.com/openwfm/JPSSdata
  46 mirror: http://repo.or.cz/git-browser/by-commit.html?r=JPSSData.git
  47
  48 ### Authors:
  49 Lauren Hearn,
  50 Jan Mandel,
  51 Angel Farguell,
  52 James Haley
  53
  54 University of Colorado Denver
  55
  56 *A subproject in the [OpenWFM project](https://github.com/openwfm) with support from NASA NNX13AH59G and NSF 1664175
  57 ### To do:
  58 - add download ability (completed)
  59 - download only certain leaves of the overall tree structure
  60 - reconcile data from M?D14 with geolocation data from M?D03 (completed)
  61 - extend MODIS search to VIIRS (completed)
  62 - continue translating ncvarinfo to proper python grammar
  63 - interpolate to a fire mesh and set up upper and lower bounds for fire arrival time (completed)
  64 - integrate in WRFXPY  https://github.com/openwfm/wrfxpy
  65
  66 ### Contains:
  67 - JPPSD.py gather data from MODIS/VIIRS for a given time window and bounding box
  68 - get_af_data.py a test driver for JPSSD.py to download all data for a given window
  69 - GOES16.py filters and downloads GOES satellite files from AWS
  70 - read_goes.py parses netCDF files for relevant fire info in given bounding box/time
  71 - interpolation.py not just interpolation but various utilities of more general nature
  72 - saveload.py a convenience utility to save and load Python objects
  73 - setup.py reads data and makes into input for statistical interpolation to estimate fire arrival time
  74 - out.mat reads data downloaded by JPPSD.py, with ability to plot granules
  75 - utils.py is a part of utils.py from https://github.com/openwfm/wrfxpy
  76 - sugarloaf.py test driver to download sample data for Sugarloaf fire into mesh and plot
  77 - ncvarinfo.py is a python version of code originally found [here](https://github.com/openwfm/wrf-fire/blob/master/other/Matlab/netcdf/private/ncvarinfo.m).
  78
  79 ### External links:
  80 - Tools for searching the CMR API https://cmr.earthdata.nasa.gov
  81 - VIIRS Active Fires users guide https://lpdaac.usgs.gov/sites/default/files/public/product_documentation/vnp14_user_guide_v1.3.pdf