Update README.md

README.md

@@ -1,3 +1,40 @@
----
-license: odbl
----
+---
+license: odbl
+---
+
+# How to use it
+Install Dataset4EO
+
+```git clone --branch streaming https://github.com/EarthNets/Dataset4EO.git```
+
+```pip install -e .```
+
+Then download the dataset from this Huggingface repo.
+
+```python
+import dataset4eo as eodata
+import time
+
+train_dataset = eodata.StreamingDataset(input_dir="optimized_enmap_corine", num_channels=5, channels_to_select=[0,1,2], shuffle=True, drop_last=True)
+sample = dataset[101]
+print(sample.keys())
+print(sample["image"])        
+print(sample["simage"].shape)
+print(sample["label"]) 
+```
+
+
+We acknowledge and give full credit to the original authors of SpectralEarth for their effort in creating this dataset.
+The dataset is re-hosted in compliance with its original license to facilitate further research. Please cite the following paper for the creation of the dataset:
+
+```
+@article{montello2022mmflood,
+  title={Mmflood: A multimodal dataset for flood delineation from satellite imagery},
+  author={Montello, Fabio and Arnaudo, Edoardo and Rossi, Claudio},
+  journal={IEEE Access},
+  volume={10},
+  pages={96774--96787},
+  year={2022},
+  publisher={IEEE}
+}
+```