Create README.md

README.md

@@ -0,0 +1,47 @@
+---
+license: mit
+---
+
+# Dataset Card for nrw-bplan-scrape
+
+## Dataset Description
+ 
+  **Homepage:** [DSSGx Munich](https://sites.google.com/view/dssgx-munich-2023/startseite) organization page. 
+ 
+  **Repository:** [GitHub](https://github.com/DSSGxMunich/land-sealing-dataset-and-analysis). 
+
+### Dataset Summary
+
+This dataset contains all inputs needed as well as outputs of running the full pipeline for creating the NRW land sealing dataset. This can be reproduced by running [this notebook](https://github.com/DSSGxMunich/land-sealing-dataset-and-analysis/blob/main/src/1_execute_pipeline.ipynb).
+
+## Dataset Structure
+
+* nrw
+  * bplan
+    * features
+      * keywords
+        * exact_search
+          * ```baunvo_keywords.csv```
+          * ```hochwasser_keywords.csv```
+        * fuzzy_search: contains xxx
+    * raw
+      * images
+      * links
+      * text
+      * pdfs
+    * knowledge_extraction_agent
+    * ```knowledge_extraction_agent.json```
+  * clean
+    * ```document_texts.xlsx```
+    * ```exact_keyword.xlsx```
+    * ```fuzzy_keyword.xlsx```
+    * ```knowledge_agent.xlsx```
+    * ```land_parcels.xlsx```
+    * ```regional_plans.xlsx```
+  * rplan
+    * features: contains ```regional_plan_sections.json```, the output of the pipeline - a more detailed can be found [here](https://huggingface.co/datasets/DSSGxMunich/regional_plan_sections)
+    * raw
+      * geo: contains ```regions_map.geojson``` with information on the geolocations of the regional plans
+      * pdfs: contains pdfs of regional plans for NRW - used as input to run the pipeline
+      * text: contains text extracted with Tika from all pdf regional plans
+