Update README.md

README.md

@@ -1,3 +1,44 @@
----
-license: mit
----
+---
+license: mit
+---
+
+# Overview
+
+Here you will find the model output parquet files and geotiffs from the following paper:
+<placeholder for arxiv link>
+
+Each file is for a 3 degree by 3 degree tile. The folder name and file names denote the southwest corner of the tile. For example, The file N27E030 would be for latitudes between 27 and 30 degrees north, and longitudes between 30 and 33 degrees east.
+
+# Schema
+
+The schema for each file is as follows:
+- year: year of the observation (int)
+- month: month of the observation (int)
+- day: day of the month of the observation (int)
+- lat: latitude of the potential flood detection (center of pixel) (float)
+- lon: longitude of the potential flood detection (center of pixel) (float) 
+- filename: Sentinel-1 file name corresponding to observation in which flooding was detected (str)
+- land_cover: Land cover mapping from ESA WorldCover for the pixel (int)
+- dem_metric_1: slope calculated for the individual pixel (float) 
+- dem_metric_2: maximum slope within 240m of the individual pixel (float) 
+- soil_moisture: absolute soil moisture as estimated by the LPRM algorithm, units in percentage points  (float) 
+- soil_moisture_zscore: soil moisture anamoly relative to the period of Oct 2014-Sep 2024 (float) 
+- soil_moisture_sca: absolute soil moisture as estimated by the SCA algorithm, units in percentage points  (float)
+- soil_moisture_sca_zscore: soil moisture sca anamoly relative to the period of Oct 2014-Sep 2024 (float)
+- temp: average daily minimum temperature for the day of the year of the observation, under current climate conditions (1991-2020) (float)
+- edge_false_positives: were any edge effects (near the edge of the image) detected for this observation (int)
+
+# Suggested Filters
+
+Here are the filters we typically apply in post processing, as described in the paper:
+- dem_metric_2 < 10
+- soil_moisture_sca > 1
+- soil_moisture_zscore > 1
+- soil_moisture > 20
+- temp > 0
+- land_cover: exclude values of 60 for bare ground
+- edge_false_positives = 0
+
+# Spatial Resolution
+
+The data is run on input data with 20 meter resolution (Status: Oct 31 2024: Africa and South America are available at 20 meters, rest of world is at 30 meters with update expected later this year)