cleanup consts

Author: roshni-b

data/consts/forcing_stats.py

@@ -1,32 +1,33 @@
-# Statistics of Relative Humidity calculated in the fwi_forcings.ipynb
-# Calculated on 12 months of data without applying the mask
+"""
+Statistics of 4 Forcings variables calculated in data/EDA/fwi_forcings.ipynb,
+calculated on 12 months of data
+"""
+
+# Relative Humidity
 FORCING_MEAN_RH = 72.47605
 FORCING_MAD_RH = 13.0844555
 FORCING_VAR_RH = 314.80286
 FORCING_STD_RH = 17.7426847
 FORCING_MIN_RH = 0.0013500393
 FORCING_MAX_RH = 100.064285
 
-# Statistics of T2 calculated in the fwi_forcings.ipynb
-# Calculated on 12 months of data without applying the mask
+# T2
 FORCING_MEAN_T2 = 279.96622
 FORCING_MAD_T2 = 16.938044
 FORCING_VAR_T2 = 452.84903
 FORCING_STD_T2 = 21.2802498
 FORCING_MIN_T2 = 193.66562
 FORCING_MAX_T2 = 324.16202
 
-# Statistics of TP calculated in the fwi_forcings.ipynb
-# Calculated on 12 months of data without applying the mask
+# TP
 FORCING_MEAN_TP = 2.4548044
 FORCING_MAD_TP = 3.0407052
 FORCING_VAR_TP = 40.771793
 FORCING_STD_TP = 6.3852794
 FORCING_MIN_TP = 0.0
 FORCING_MAX_TP = 1097.1971
 
-# Statistics of Wind Speed calculated in the fwi_forcings.ipynb
-# Calculated on 12 months of data without applying the mask
+# Wind Speed
 FORCING_MEAN_WSPEED = 6.4765906
 FORCING_MAD_WSPEED = 2.936887
 FORCING_VAR_WSPEED = 13.666987

data/consts/forecast_stats.py

@@ -1,5 +1,8 @@
-# Statistics of FWI forecast calculated on 6 month of data demonstrated
-# in the fwi_forecast.ipynb notebook. Calculated without applying the mask
+"""
+Statistics of FWI forecast calculated on 6 month of data calculated in
+data/EDA/fwi_forecast.ipynb.
+"""
+
 FORECAST_FWI_MEAN = 18.389227
 FORECAST_FWI_MAD = 20.80943
 FORECAST_FWI_VAR = 716.1736

data/consts/frp_stats.py

@@ -1,19 +1,21 @@
-# Statistics of FRP calculated on 12 month of data demonstrated in the
-# frp.ipynb notebook. Calculated without applying mask or transformation
+"""
+Statistics of FRP calculated on 12 month of data demonstrated in
+data/EDA/frp.ipynb.
+"""
+
 FRP_MEAN = 0.00021382833
 FRP_MAD = 0.0004302753
 FRP_VAR = 0.0012904834002256393
 FRP_MIN = -7.62939453125e-06
 FRP_MAX = 186.10562133789062
 
-# Statistics of FRP calculated on 12 month of data demonstrated in the
-# frp.ipynb notebook. Calculated after applying boxcox transform
+# After applying box-cox transform
 BOX_COX_FRP_MEAN = -0.06211442
 BOX_COX_FRP_MAD = 0.4730961
 BOX_COX_FRP_VAR = 0.30641195
 BOX_COX_FRP_MIN = -0.9396674
 BOX_COX_FRP_MAX = 1.1760247
 BOX_COX_LAMBDA = -0.8397658852658973
 
-# Pre-transform stats of frp.ipynb
+# Pre-transform stats
 PRE_TRANSFORM_FRP_MAD = 1.3919744

data/consts/fwi_reanalysis_stats.py

@@ -1,11 +1,13 @@
-# Statistics of FWI reanalysis calculated on 12 month of data demonstrated
-# in the fwi_reanalysis.ipynb notebook. Calculated without applying the mask
+"""
+Statistics of FWI reanalysis calculated on 12 month of data demonstrated
+in data/EDA/fwi_reanalysis.ipynb.
+"""
+
 REANALYSIS_FWI_MEAN = 15.292629
 REANALYSIS_FWI_MAD = 18.819166
 REANALYSIS_FWI_VAR = 621.65894
 REANALYSIS_FWI_MIN = 1.7216163e-09
 REANALYSIS_FWI_MAX = 304.7236
 
-# The variance of FWI reanalysis calculated after applying the
-# box-cox transformation
+# Variance after applying box-cox transformation
 PROCESSED_REANALYSIS_FWI_VAR = 10.813191

data/consts/soil_moisture_stats.py

@@ -1,4 +1,8 @@
-# Calculated in the soil_moisture.ipynb file
+"""
+Statistics of the soil moisture variable calculated in data/EDA/soil_moisture.ipynb
+calculated on 12 months of data
+"""
+
 SOIL_MOISTURE_MEAN = 11.092642
 SOIL_MOISTURE_VAR = 73.31705
 SOIL_MOISTURE_STD = 8.56253759