Update README.md
Browse files
README.md
CHANGED
|
@@ -11,10 +11,23 @@ pinned: false
|
|
| 11 |
short_description: Streamlit template space
|
| 12 |
license: mit
|
| 13 |
---
|
|
|
|
| 14 |
|
| 15 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 16 |
|
| 17 |
-
Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
|
| 18 |
|
| 19 |
-
If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
|
| 20 |
-
forums](https://discuss.streamlit.io).
|
|
|
|
| 11 |
short_description: Streamlit template space
|
| 12 |
license: mit
|
| 13 |
---
|
| 14 |
+
# WNTR-QGIS-style Streamlit App
|
| 15 |
|
| 16 |
+
This app replicates the core functionality of the WNTR-QGIS plugin using Streamlit, ready for deployment on Hugging Face Spaces.
|
| 17 |
+
|
| 18 |
+
## Features
|
| 19 |
+
|
| 20 |
+
- Upload and simulate EPANET `.inp` files
|
| 21 |
+
- Choose between `EpanetSimulator` and `WNTRSimulator`
|
| 22 |
+
- Visualize node metrics (pressure/head) using Plotly
|
| 23 |
+
- Export and analyze results (to be extended)
|
| 24 |
+
|
| 25 |
+
## Deployment
|
| 26 |
+
|
| 27 |
+
Use the included `Dockerfile` to deploy on HF Spaces or locally via:
|
| 28 |
+
|
| 29 |
+
```bash
|
| 30 |
+
streamlit run app.py
|
| 31 |
+
```
|
| 32 |
|
|
|
|
| 33 |
|
|
|
|
|
|