Roshal commited on
Commit
f87b2e8
Β·
verified Β·
1 Parent(s): d69f23d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +46 -13
README.md CHANGED
@@ -61,7 +61,19 @@ pretty_name: NestEO Prototype
61
  # configs:
62
  # - config_name: default
63
  # data_files: metadata_current/scene_parameters/newsat*.parquet
 
64
 
 
 
 
 
 
 
 
 
 
 
 
65
 
66
  ---
67
 
@@ -72,46 +84,67 @@ NestEO is a hierarchical, resolution-aligned, UTM-based nested grid dataset fram
72
 
73
  **Grid Levels**: 120000m, 12000m, 2400m, 1200m, 600m, 300m, 150m
74
  **Grid Metadata**: ESA WorldCover proportions, GHSL, KΓΆppen Climate
75
- **Current Datasets**: Wyvren Hyperspectral, Satellogic Newsat
76
  **Zones**: UTM 1N–60N, 1S–60S and Polar North/South
77
  **Formats**: Parquet, GeoParquet, Zarr (planned)
78
  **License**: CC-BY-4.0
79
  **More Info**: See [paper](link), [GitHub](https://github.com/mbzuai-oryx/NestEO).
80
 
81
 
82
- ## Directory Structure
83
 
84
  ```text
85
  NestEO/
86
  β”œβ”€β”€ grids/ # UTM-aligned hierarchical grid Parquet files
87
- β”œβ”€β”€ metadata_current/ # Precomputed proportions: landcover, climate, region
88
- β”œβ”€β”€ datasets_EO/ # Clipped EO imagery tiles (Sentinel, MODIS, etc.)
89
- β”œβ”€β”€ datasets_AUX/ # Auxiliary datasets (DEM, landcover, OSM)
90
- β”œβ”€β”€ embeddings/ # Precomputed model embeddings (e.g., DINOv2, SigLIP)
91
  β”œβ”€β”€ index_structure/ # tile-to-super-tile, Source-to-tile and tile-ID index maps
92
  └── versions/ # Information about snapshots for version control
93
  ```
94
 
95
  ## Dataset Structure
96
- - Each tile includes a unique `tile_id`, `super_id`, and spatial geometry.
97
  - Grouped by zone directories: `grid_2400m/grid_37N_2400.parquet`
98
 
 
 
 
99
 
100
  **How to Use**
101
 
 
102
  * Load a grid from grids/ (e.g., grid_1200m.parquet).
103
  * Join with metadata (e.g., metadata_lc.parquet) on tile_id.
104
- * Apply spatial or semantic filtering (e.g., only urban, low-cloud).
105
- * Select and load EO imagery and AUX sources from paired folders.
106
- * Use embeddings (optional) for transfer learning or clustering.
107
 
108
  **Current Status**
109
 
110
- This is an initial prototype release. Some EO source folders are partially populated, and ongoing ingestion is underway. Metadata filtering and source-pairing are fully supported.
111
 
112
  **Limitations**
113
- - Current version includes only structural grid and metadata, along with a few EO data sources
114
- - Further EO content layers (imagery, land cover, auxillary layers etc.) to be added in coming updates
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
115
 
116
  **Contributing**
117
 
 
61
  # configs:
62
  # - config_name: default
63
  # data_files: metadata_current/scene_parameters/newsat*.parquet
64
+ ---
65
 
66
+ ---
67
+ configs:
68
+ - config_name: grids_selected_1200m # appears in the drop-down
69
+ default: true # <- this is what the viewer shows first
70
+ data_files:
71
+ - split: train
72
+ path: "grids/grids_selected/selected_1200m_grid.parquet"
73
+ <!-- - config_name: legacy_full_grid # keep the old file available
74
+ data_files:
75
+ - split: train
76
+ path: "old_folder/old_grid.parquet" # adjust to real path -->
77
 
78
  ---
79
 
 
84
 
85
  **Grid Levels**: 120000m, 12000m, 2400m, 1200m, 600m, 300m, 150m
86
  **Grid Metadata**: ESA WorldCover proportions, GHSL, KΓΆppen Climate
87
+ **Current Sample Datasets**: Wyvren Hyperspectral, Satellogic Newsat, Sentinel-2, Sentinel-1, Sentinel-3
88
  **Zones**: UTM 1N–60N, 1S–60S and Polar North/South
89
  **Formats**: Parquet, GeoParquet, Zarr (planned)
90
  **License**: CC-BY-4.0
91
  **More Info**: See [paper](link), [GitHub](https://github.com/mbzuai-oryx/NestEO).
92
 
93
 
94
+ ## Directory Structure Scaffold
95
 
96
  ```text
97
  NestEO/
98
  β”œβ”€β”€ grids/ # UTM-aligned hierarchical grid Parquet files
99
+ β”œβ”€β”€ metadata_current/ # Precomputed proportions: landcover, planned (climate, region, biomes, ghsl)
100
+ β”œβ”€β”€ datasets_EO/ # Clipped EO imagery tiles (Newsat, Sentinels, planned(Landsat, HLS, MODIS, etc.))
101
+ β”œβ”€β”€ datasets_AUX/ # Auxiliary datasets planned(DEM, landcover, OSM)
102
+ β”œβ”€β”€ embeddings/ # Precomputed model embeddings planned (e.g., DINOv2, SigLIP, SAM, SAM2)
103
  β”œβ”€β”€ index_structure/ # tile-to-super-tile, Source-to-tile and tile-ID index maps
104
  └── versions/ # Information about snapshots for version control
105
  ```
106
 
107
  ## Dataset Structure
108
+ - Each tile includes a unique `tile_id`, and spatial geometry.
109
  - Grouped by zone directories: `grid_2400m/grid_37N_2400.parquet`
110
 
111
+ ## Code
112
+ Github code provides the grid creation logic, ESA Worldcover proportion calculations, notebooks for processing sample datasets, and fetching/merging grids with datasets
113
+
114
 
115
  **How to Use**
116
 
117
+ * Install from Github and create your own Nested grid structure
118
  * Load a grid from grids/ (e.g., grid_1200m.parquet).
119
  * Join with metadata (e.g., metadata_lc.parquet) on tile_id.
120
+ * Apply spatial or semantic filtering (e.g., only urban, with specific dates).
121
+ * Select and load paired EO imagery and sources from folders.
122
+
123
 
124
  **Current Status**
125
 
126
+ This is a prototype release of the NestEO dataset framework, showcasing the core design principles, including hierarchical UTM-aligned grids, modular directory layout, structured GeoParquet-based metadata, and compatibility with scalable Earth Observation (EO) data ingestion. This release includes a limited set of EO source tiles and metadata layers meant to demonstrate framework usability, alignment strategies, and pipeline extensibility. Metadata-driven filtering, source-pairing, and tile-to-super-tile indexing are fully implemented.
127
 
128
  **Limitations**
129
+ - This version provides a demonstration of the framework vision. Only few selected EO modalities (e.g., Sentinel-2, Sentinel-3, Satellogic, Wyvren) are currently included at sample scale.
130
+ - Further EO content layers (imagery, land cover, auxillary layers etc.) to be added in later updates for NestEOv1.
131
+ - Cross-modal pairings, auxiliary layers (e.g., DEM, OSM), and full-resolution coverage across grid levels are under active development.
132
+ - Not all grid levels are currently populated with imagery; some grid layers are provided primarily to support alignment, pairing and demonstration purposes.
133
+
134
+ ### Roadmap and Ongoing Work
135
+
136
+ A comprehensive **v1 release** is under development. This upcoming version will include:
137
+
138
+ - **12+ EO modalities** (optical, SAR, hyperspectral, atmospheric, thermal)
139
+ - **Over 250,000 geospatially distributed tiles** across multiple grid levels
140
+ - **Paired imagery samples** at selected locations, across grid levels, supporting multimodal learning
141
+ - **Expanded metadata layers** including ESA WorldCover, Copernicus DEM, KΓΆppen-Geiger zones, and GHSL-derived population classes
142
+ - **Precomputed model embeddings** (e.g., DINOv2, SigLIP, SAM2) at tile-level granularity
143
+ - **Full compatibility** with cloud-based filtering, lazy loading, and Hugging Face Datasets
144
+
145
+ All v1 expansions will preserve the **NestEO prototype structure** and align with **FAIR dataset development practices**. The prototype release remains stable as a referential snapshot of the NestEO design framework, while v1 will extend data completeness, modeling readiness and potential foundation model development.
146
+
147
+
148
 
149
  **Contributing**
150