docs: update wiki

Author: cuongth95

docs/index.md

@@ -1,20 +1,39 @@
-# DiTEC-WDN - The Gigantic Dataset
+# DiTEC-WDN Dataset (DWD)
 
-This work includes a collection of synthetic scenarios devised from 36 **Water Distribution Networks (WDNs)**. 
+DWD is a collection of synthetic, simulated and steady-state scenarios derived from 36 **Water Distribution Networks (WDNs)**.
 
-For the sake of clarity, it would be better to get into familiarized concepts:
+Each network has 1,000 distinct hydraulic scenarios generated by an open-sourced simulation toolkit EPANET. 
+
+We then describe surronding concepts as follows:
 
 * **Scenario** denotes as a sequence of snapshots.
 
-* **Snapshot** represents a measured steady-state of a particular WDN and is often modelled as an undirect graph.
+* **Snapshot** represents as a network's state often modelled as a graph at a particular timestep.  
+
+* **Nodes** models a reservoir, junction, or tank in the snapshot graph. Each type has same properties and unique ones. 
+
+* **Edges** refers pipe, pump, or valve in the snapshot graph. Each type has same properties and unique ones. 
+
+* **Input parameters** involves in simulation input parameters, such as demands, pipe diameter, and so on.
+
+* **Output parameters** includes simulation measurements (e.g., pressure, flow rate, head, ...)
+
+Both parameters are described as nodal/edge features in the snapshot graph. Their values are diverse but temporally correlated with those of other snapshots in the **same** scenario. 
+However, in DWD, any two scenarios are independent and unrelated since they are created from different configurations (despite the same original network).
+
+DWD is designed to:
+
+* Promote open scientific research in the water domain.
+
+* Eliminate risks of exposing sensitive data, privacy issues, or safety concerns.
 
-* **Input parameters** includes simulation inputs, such as demands, pipe diameter, and so on.
+* Provide a benchmark for data-driven machine learning methods and large-scale scenario analysis.
 
-* **Output parameters** includes simulation outcomes which researchers are interested in (e.g., pressure, flow rate, head, ...)
+This wiki details the process of creating DWD, including parameter optimization, simulation, and encapsulation.
 
-Both parameters are described as nodal/edge features in the snapshot graph. Their values are diverse but temporal correlated with those of other snapshots in the **same** scenario. 
-However, in DiTEC-WDN, two scenarios are considered completely different WDNs despite their origin being the same network.
+It also explains how to use DWD’s data interface, GiDA.
 
+With just two inputs, an .INP file and a YAML configuration, you can generate diverse scenarios and apply this to your own private WDN.
 
 # Acknowledgement
 This work is funded by the project DiTEC: Digital Twin for Evolutionary Changes in Water Networks (NWO 19454).

docs/installation.md

@@ -1,8 +1,13 @@
-# Manually download the data
-TODO: Update later
+# Download Data
+**DWD** are shipped in two formats: `.parquet` and `.zarr`. Both has their own advantages and drawbacks:
+
+* `.parquet` files are fully supported by Hugging Face, and can be downloaded in subfiles by parameters, but are unoptimized in our data interface.
+* `.zarr` files enable fast querying and processing, but they must be downloaded as a complete archive representing an entire network.
+
+To download, please visit the Hugging Face [repository](https://huggingface.co/datasets/rugds/ditec-wdn/tree/main).
 
 # Instal the Data Interface
-Currently, DiTEC-WDN is available for Python >= 3.10. Please setup a virtual environment before installation.
+DiTEC-WDN is available for Python >= 3.10. Please setup a virtual environment before installation.
 
 As some libraries are tailored to your OS and CUDA, user should install them separately as follows:
 
@@ -17,5 +22,11 @@ Afterwards, you can clone DiTEC-WDN or install it via pip:
 pip install git+https://github.com/DiTEC-project/DiTEC_WDN_dataset.git
 ```
 
-Tada! DiTEC-WDN data interface has been installed! 
+Then, required libraries are listed in `requirements.txt` that can be downloaded using this command:
+
+```python
+pip install -R requirments.txt
+```
+
+Tada! DiTEC-WDN data interface has been installed!