Update README.md

README.md

@@ -1,52 +1,59 @@
 ---
 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 structure is as follows:
-- Main directory by latitude
-- Subdirectory for each tile
-- Each subdirectory contains 3 files:
-  - parquet files with tabular data
-  - geotiff with 90 meter buffer applied on filtered dataset (see paper for details)
-  - same as above but with 240 meter buffer applied
-
-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. Its files would be in the N27 folder.
-
-# 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)
+# Flood Detection Dataset
+
+## Overview
+This repository contains model output parquet files and geotiffs from our flood detection research. The data is organized in 3° × 3° tiles, with each tile containing both tabular data and processed geotiff images.
+
+## Directory Structure
+```
+├── N27                          # Main directory by latitude
+│   ├── N27E030                 # Subdirectory for specific tile
+│   │   ├── N27E030.parquet    # Tabular data
+│   │   ├── N27E030_90m.tif    # Geotiff with 90m buffer
+│   │   └── N27E030_240m.tif   # Geotiff with 240m buffer
+```
+
+The naming convention uses the southwest corner coordinates of each tile. For example, `N27E030` represents:
+- Latitude: 27°N to 30°N
+- Longitude: 30°E to 33°E
+
+## Schema
+| Column | Type | Description |
+|--------|------|-------------|
+| year | int | Year of observation |
+| month | int | Month of observation |
+| day | int | Day of observation |
+| lat | float | Latitude of potential flood detection (pixel center) |
+| lon | float | Longitude of potential flood detection (pixel center) |
+| filename | str | Corresponding Sentinel-1 file name |
+| land_cover | int | ESA WorldCover land cover classification |
+| dem_metric_1 | float | Individual pixel slope |
+| dem_metric_2 | float | Maximum slope within 240m |
+| soil_moisture | float | LPRM algorithm absolute soil moisture (%) |
+| soil_moisture_zscore | float | Soil moisture anomaly (Oct 2014-Sep 2024 baseline) |
+| soil_moisture_sca | float | SCA algorithm absolute soil moisture (%) |
+| soil_moisture_sca_zscore | float | SCA soil moisture anomaly (Oct 2014-Sep 2024 baseline) |
+| temp | float | Average daily minimum temperature (1991-2020 climate) |
+| edge_false_positives | int | Edge effect detection flag |
+
+## Recommended Filtering
+For optimal results, we recommend applying the following filters:
+
+```python
+filters = {
+    'dem_metric_2': '< 10',
+    'soil_moisture_sca': '> 1',
+    'soil_moisture_zscore': '> 1',
+    'soil_moisture': '> 20',
+    'temp': '> 0',
+    'land_cover': '!= 60',  # exclude bare ground
+    'edge_false_positives': '= 0'
+}
+```
+
+## Spatial Resolution
+- Current Status (Oct 31, 2024):
+  - Africa and South America: 20-meter resolution
+  - Rest of world: 30-meter resolution (20-meter update expected later this year)