fmda/README.md

   1 # FMDA Readme
   2
   3 Code repository for project to build RNN models to predict dead fuel moisture content
   4
   5 ## Setup
   6
   7 Clone repository:
   8         git clone https://github.com/openwfm/notebooks
   9
  10 Build and activate environment:
  11     * cd ./fmda/install
  12     * conda env create -f fmda_ml.yml
  13     * conda activate fmda_ml
  14
  15
  16 ## Main Notebooks
  17
  18 * version_control/rnn_train_versions.ipynb
  19     - Runs model in testing type mode where exact initial and fitted hashes are checked against known history
  20         - Shows reproducibility changes and major code restructuring
  21
  22 * fmda_rnn_serial.ipynb
  23     - Automatically retrieves fmda dictionary from OpenWFM Demo
  24     - Trains and predicts the model at multiple locations in serial fashion
  25          1. Train separate models at multiple locations and compare predictions on that location itself
  26          2. Train single model with data from multiple locations. Take same model object and call .fit multiple times. Compare predictions for new locations
  27
  28 ## Data
  29
  30 The data structure used for this project is nested dictionaries. A "case" of data consists of FMC observations and atmospheric data at a particular location. The FMC data always comes from RAWS ground-level observations, and the atmospheric data can be from a variety of sources. The data acquisition for this project is built off a branch of `wrfxpy`, branch "develop-72-jh", which merges RAWS and HRRR data
  31
  32 - Saved within the repository is a dataset used to ensure reproducibility. As of 20-6-2024, that file is: `data\reproducibility_dict2.pickle`
  33 - Other formatted FMDA dictionaries are staged at the OpenWFM demo page and retrieved via wget:
  34 https://demo.openwfm.org/web/data/fmda/dicts/
  35
  36 ## RNN Code
  37
  38 The source code lives in the module "moisture_rnn.py". The module has:
  39
  40 * Superclass RNNModel
  41         - Child class for SimpleRNN
  42         - Child class for LSTM
  43 * Helper code to format data for RNN
  44         - staircase_2 used to batch/sequence timeseries data
  45
  46
  47