razaali10 commited on
Commit
8198cbc
Β·
verified Β·
1 Parent(s): add16c6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +15 -15
README.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- title: EPANET Simulation Tool (Gradio + EPyT)
3
  emoji: πŸ’§
4
  colorFrom: indigo
5
  colorTo: blue
@@ -8,33 +8,33 @@ app_file: app.py
8
  pinned: false
9
  ---
10
 
11
- # πŸ’§ EPANET Simulation Tool (Gradio + EPyT)
12
 
13
- This Hugging Face Space allows you to upload a `.inp` file (EPANET hydraulic model) and simulate it using the [OpenWaterAnalytics/EPyT](https://github.com/OpenWaterAnalytics/EPyT) toolkit.
14
 
15
  🧩 **Features**:
16
- - Upload `.inp` files from EPANET
17
- - Simulate hydraulic behavior using Python
18
  - View node head results from the first timestep
19
- - Docker-based: full control over environment
 
20
 
21
  πŸ“¦ **Powered by**:
22
- - [Gradio](https://gradio.app/) for UI
23
- - [EPyT](https://github.com/OpenWaterAnalytics/EPyT) for simulation
24
- - Python 3.11 in a Docker container
25
-
26
- πŸ“ Compatible with Hugging Face [Chat UI](https://huggingface.co/docs/chat-ui/en/index) and LLM tool use via function calling.
27
 
28
  ---
29
 
30
- ### πŸš€ Usage
31
 
32
- 1. Click the **Upload** button and select your `.inp` file
33
- 2. The app will simulate the network hydraulics
34
- 3. Results (node head values) are shown in the output
35
 
36
  ---
37
 
38
  ### πŸ“˜ Example Output
39
 
40
 
 
 
1
  ---
2
+ title: EPANET Simulation Tool (Gradio + WNTR)
3
  emoji: πŸ’§
4
  colorFrom: indigo
5
  colorTo: blue
 
8
  pinned: false
9
  ---
10
 
11
+ # πŸ’§ EPANET Simulation Tool (Gradio + WNTR)
12
 
13
+ This Hugging Face Space allows you to upload a `.inp` file (an EPANET hydraulic model) and simulate it using the [WNTR (Water Network Tool for Resilience)](https://github.com/USEPA/WNTR) library developed by the U.S. EPA.
14
 
15
  🧩 **Features**:
16
+ - Upload and simulate EPANET `.inp` files
17
+ - Run hydraulic simulations using WNTR’s built-in EPANET simulator
18
  - View node head results from the first timestep
19
+ - Lightweight, Python-only, no EPANET binary required
20
+ - Deployed inside a reproducible Docker container
21
 
22
  πŸ“¦ **Powered by**:
23
+ - [Gradio](https://gradio.app/) – for file upload and result display
24
+ - [WNTR](https://pypi.org/project/wntr/) – for EPANET-compatible simulation
25
+ - [Python](https://www.python.org/) 3.11 + Hugging Face Docker Spaces
 
 
26
 
27
  ---
28
 
29
+ ### πŸš€ How to Use
30
 
31
+ 1. Click the **Upload** button to submit your `.inp` file
32
+ 2. The app will simulate the hydraulic behavior of the network
33
+ 3. You’ll see a summary of node heads (pressure level) at time `0`
34
 
35
  ---
36
 
37
  ### πŸ“˜ Example Output
38
 
39
 
40
+