Metadata-Version: 2.4
Name: ditec-water-dataset
Version: 1.0.7
Summary: 
License: MIT
License-File: LICENSE
Author: htruong
Author-email: truonghuycuong95@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: dask (>=2025.2.0,<2026.0.0)
Requires-Dist: numcodecs (>=0.12.1,<0.13.0)
Requires-Dist: scipy (>=1.15.2,<2.0.0)
Requires-Dist: torch_geometric (>=2.5.3,<3.0.0)
Requires-Dist: typed-argument-parser (>=1.9.0,<2.0.0)
Requires-Dist: wntr (>=1.1.0,<2.0.0)
Requires-Dist: zarr (>=2.16.1,<3.0.0)
Description-Content-Type: text/markdown

 # DiTEC-WDN

This is the official repository for the paper:  
**DiTEC-WDN: A Large-Scale Dataset of Hydraulic Scenarios across Multiple Water Distribution Networks**.

This repository contains configuration optimization, scenario generation, and encapsulation code for the **DiTEC-WDN** dataset.

This is useful for individuals or organizations to generate scenarios on their own private Water Distribution Networks. 

Those interested in the data can directly refer to the [dataset](https://huggingface.co/datasets/rugds/ditec-wdn).

# Tutorial
Access the wiki at [https://ditec-project.github.io/DiTEC_WDN_dataset](https://ditec-project.github.io/DiTEC_WDN_dataset) for more details.


# Repo map
```
    |-- arguments   - where configs stored
    |-- core        - code for interface, demand generator, simgen
    |-- inputs      - contains original INP files
    |-- opt         - code for PSO
    |-- utils       - where we access utils functions
    |-- vis         - code for visualization
    |-- docs        - documentation how to use modules & inteface
```

# License
MIT license. See the LICENSE file for more details.

# Citing DiTEC-WDN

If you use the dataset or the code, please cite:

```latex
@article{truong2025dwd,
  author    = {Huy Truong and Andr{\'e}s Tello and Alexander Lazovik and Victoria Degeler},
  title     = {DiTEC-WDN: A Large-Scale Dataset of Hydraulic Scenarios across Multiple Water Distribution Networks},
  journal   = {Scientific Data},
  year      = {2025},
  volume    = {12},
  number    = {1},
  pages     = {1733},
  doi       = {10.1038/s41597-025-06026-0},
  url       = {https://doi.org/10.1038/s41597-025-06026-0},
  issn      = {2052-4463}
}
```

