epanet-mcp-server 0.1.0__tar.gz

epanet_mcp_server-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026-     EURECAT.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

epanet_mcp_server-0.1.0/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: epanet-mcp-server
+Version: 0.1.0
+Summary: MCP server for EPANET water distribution network simulation via ePyT
+License: MIT
+Keywords: epanet,epyt,mcp,water-distribution,hydraulic-simulation
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: epyt>=2.0.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: pandas>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# EPANET MCP Server
+
+[![Linter](https://github.com/Applied-Artificial-Intelligence-Eurecat/epanet-mcp-server/actions/workflows/linter.yml/badge.svg?branch=main)](https://github.com/Applied-Artificial-Intelligence-Eurecat/epanet-mcp-server/actions/workflows/linter.yml)
+[![Pytest](https://github.com/Applied-Artificial-Intelligence-Eurecat/epanet-mcp-server/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/Applied-Artificial-Intelligence-Eurecat/epanet-mcp-server/actions/workflows/test.yml)
+
+A [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server that
+exposes EPANET water-distribution network modelling capabilities through
+[ePyT](https://github.com/KIOS-Research/EPyT) - the EPANET Python Toolkit.
+
+Any MCP-compatible LLM can load water network models, run
+simulations, modify parameters, and generate complex what-if scenarios through
+natural language.
+
+---
+
+## Features
+
+| Category | Tools |
+|---|---|
+| **Load & Inspect** | `load_network`, `unload_network`, `list_networks`, `list_bundled_networks`, `get_network_summary`, `get_nodes`, `get_links`, `get_patterns`, `get_controls`, `get_curves`, `get_options` |
+| **Simulate** | `run_hydraulic_simulation`, `run_quality_simulation`, `run_full_simulation`, `get_pressure_at_time`, `get_flow_at_time` |
+| **Modify** | `set_node_base_demand`, `set_pattern`, `add_pattern`, `set_pipe_diameter`, `set_pipe_roughness`, `set_pipe_status`, `set_pipe_length`, `set_pump_status`, `set_pump_speed`, `set_pump_head_curve`, `set_valve_setting`, `set_valve_status`, `set_tank_parameters`, `set_reservoir_head`, `set_simulation_duration`, `set_hydraulic_timestep`, `set_quality_timestep`, `set_quality_type`, `add_control`, `delete_control`, `save_network` |
+| **Scenarios** | `create_demand_perturbation`, `create_leakage_event`, `create_contamination_event`, `create_pressure_change_scenario`, `create_pump_control_scenario`, `create_valve_control_scenario`, `create_multi_failure_scenario` |
+
+---
+
+## Requirements
+
+- Python ≥ 3.10
+- [ePyT](https://pypi.org/project/epyt/) ≥ 2.0
+- [mcp](https://pypi.org/project/mcp/) ≥ 1.0
+
+```bash
+pip install epyt mcp
+```
+
+---
+
+## Installation
+
+```bash
+git clone https://github.com/Applied-Artificial-Intelligence-Eurecat/epanet-mcp-server.git
+cd epanet-mcp-server
+pip install -e .
+```
+
+---
+
+## Running the server
+
+### stdio (for Claude Desktop / Claude Code)
+
+```bash
+epanet-mcp-server
+# or
+python -m epanet_mcp.server
+```
+
+### SSE / HTTP
+
+```bash
+epanet-mcp-server --transport sse --port 8000
+```
+
+---
+
+## Claude Desktop configuration
+
+Add to `~/Library/Application Support/Claude/claude_desktop_config.json`
+(macOS) or the equivalent on your platform:
+
+```json
+{
+  "mcpServers": {
+    "epanet": {
+      "command": "epanet-mcp-server",
+      "args": []
+    }
+  }
+}
+```
+
+If not on `PATH`:
+
+```json
+{
+  "mcpServers": {
+    "epanet": {
+      "command": "python",
+      "args": ["-m", "epanet_mcp.server"],
+      "cwd": "/path/to/epanet-mcp-server/src"
+    }
+  }
+}
+```
+
+---
+
+## Claude Code (`.mcp.json`)
+
+Place this in the root of your project or `~/.claude/`:
+
+```json
+{
+  "mcpServers": {
+    "epanet": {
+      "command": "epanet-mcp-server",
+      "args": []
+    }
+  }
+}
+```
+
+---
+
+## Example interactions
+
+Once the server is connected, you can ask things like:
+
+> **"Load Net1.inp and show me a summary of the network."**
+
+> **"Run a hydraulic simulation and tell me which node has the lowest pressure at hour 12."**
+
+> **"Double the base demand at junction 11 and re-run the simulation. How does pressure change?"**
+
+> **"Simulate a burst on pipe 10 with a 20% leakage fraction."**
+
+> **"Inject 10 mg/L of chlorine at node 11 between hours 1 and 3 and show me the contamination spread."**
+
+> **"What happens to pressures if the reservoir head drops from 150 m to 120 m?"**
+
+> **"Schedule Pump 9 to start at 06:00 and stop at 22:00."**
+
+> **"Close pipes 10 and 11 and the pump simultaneously. Where are service disruptions?"**
+
+---
+
+## Architecture
+
+```
+src/epanet_mcp/
+├── server.py          # FastMCP server – tool registration + entry point
+├── session.py         # Thread-safe registry of open ePyT sessions
+├── utils.py           # numpy → Python serialisation helpers
+└── tools/
+    ├── inspection.py  # load / inspect network models
+    ├── simulation.py  # run hydraulic & quality simulations
+    ├── modification.py# in-memory parameter changes
+    └── scenarios.py   # what-if scenario generators (clone + modify + run)
+```
+
+**Session model**: Each loaded network lives in a named session.  Scenario
+tools automatically clone the source session into a new independent session so
+the baseline network is never mutated.
+
+---
+
+## Running the tests
+
+```bash
+pip install pytest
+pytest tests/ -v
+```
+
+---
+
+## Bundled networks
+
+ePyT ships with many standard benchmark networks including Net1, Net2, L-TOWN,
+Hanoi, Anytown, Balerma and others.  Use `list_bundled_networks` to discover
+them all.
+
+---
+
+## License
+
+MIT

epanet_mcp_server-0.1.0/README.md

@@ -0,0 +1,177 @@
+# EPANET MCP Server
+
+[![Linter](https://github.com/Applied-Artificial-Intelligence-Eurecat/epanet-mcp-server/actions/workflows/linter.yml/badge.svg?branch=main)](https://github.com/Applied-Artificial-Intelligence-Eurecat/epanet-mcp-server/actions/workflows/linter.yml)
+[![Pytest](https://github.com/Applied-Artificial-Intelligence-Eurecat/epanet-mcp-server/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/Applied-Artificial-Intelligence-Eurecat/epanet-mcp-server/actions/workflows/test.yml)
+
+A [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server that
+exposes EPANET water-distribution network modelling capabilities through
+[ePyT](https://github.com/KIOS-Research/EPyT) - the EPANET Python Toolkit.
+
+Any MCP-compatible LLM can load water network models, run
+simulations, modify parameters, and generate complex what-if scenarios through
+natural language.
+
+---
+
+## Features
+
+| Category | Tools |
+|---|---|
+| **Load & Inspect** | `load_network`, `unload_network`, `list_networks`, `list_bundled_networks`, `get_network_summary`, `get_nodes`, `get_links`, `get_patterns`, `get_controls`, `get_curves`, `get_options` |
+| **Simulate** | `run_hydraulic_simulation`, `run_quality_simulation`, `run_full_simulation`, `get_pressure_at_time`, `get_flow_at_time` |
+| **Modify** | `set_node_base_demand`, `set_pattern`, `add_pattern`, `set_pipe_diameter`, `set_pipe_roughness`, `set_pipe_status`, `set_pipe_length`, `set_pump_status`, `set_pump_speed`, `set_pump_head_curve`, `set_valve_setting`, `set_valve_status`, `set_tank_parameters`, `set_reservoir_head`, `set_simulation_duration`, `set_hydraulic_timestep`, `set_quality_timestep`, `set_quality_type`, `add_control`, `delete_control`, `save_network` |
+| **Scenarios** | `create_demand_perturbation`, `create_leakage_event`, `create_contamination_event`, `create_pressure_change_scenario`, `create_pump_control_scenario`, `create_valve_control_scenario`, `create_multi_failure_scenario` |
+
+---
+
+## Requirements
+
+- Python ≥ 3.10
+- [ePyT](https://pypi.org/project/epyt/) ≥ 2.0
+- [mcp](https://pypi.org/project/mcp/) ≥ 1.0
+
+```bash
+pip install epyt mcp
+```
+
+---
+
+## Installation
+
+```bash
+git clone https://github.com/Applied-Artificial-Intelligence-Eurecat/epanet-mcp-server.git
+cd epanet-mcp-server
+pip install -e .
+```
+
+---
+
+## Running the server
+
+### stdio (for Claude Desktop / Claude Code)
+
+```bash
+epanet-mcp-server
+# or
+python -m epanet_mcp.server
+```
+
+### SSE / HTTP
+
+```bash
+epanet-mcp-server --transport sse --port 8000
+```
+
+---
+
+## Claude Desktop configuration
+
+Add to `~/Library/Application Support/Claude/claude_desktop_config.json`
+(macOS) or the equivalent on your platform:
+
+```json
+{
+  "mcpServers": {
+    "epanet": {
+      "command": "epanet-mcp-server",
+      "args": []
+    }
+  }
+}
+```
+
+If not on `PATH`:
+
+```json
+{
+  "mcpServers": {
+    "epanet": {
+      "command": "python",
+      "args": ["-m", "epanet_mcp.server"],
+      "cwd": "/path/to/epanet-mcp-server/src"
+    }
+  }
+}
+```
+
+---
+
+## Claude Code (`.mcp.json`)
+
+Place this in the root of your project or `~/.claude/`:
+
+```json
+{
+  "mcpServers": {
+    "epanet": {
+      "command": "epanet-mcp-server",
+      "args": []
+    }
+  }
+}
+```
+
+---
+
+## Example interactions
+
+Once the server is connected, you can ask things like:
+
+> **"Load Net1.inp and show me a summary of the network."**
+
+> **"Run a hydraulic simulation and tell me which node has the lowest pressure at hour 12."**
+
+> **"Double the base demand at junction 11 and re-run the simulation. How does pressure change?"**
+
+> **"Simulate a burst on pipe 10 with a 20% leakage fraction."**
+
+> **"Inject 10 mg/L of chlorine at node 11 between hours 1 and 3 and show me the contamination spread."**
+
+> **"What happens to pressures if the reservoir head drops from 150 m to 120 m?"**
+
+> **"Schedule Pump 9 to start at 06:00 and stop at 22:00."**
+
+> **"Close pipes 10 and 11 and the pump simultaneously. Where are service disruptions?"**
+
+---
+
+## Architecture
+
+```
+src/epanet_mcp/
+├── server.py          # FastMCP server – tool registration + entry point
+├── session.py         # Thread-safe registry of open ePyT sessions
+├── utils.py           # numpy → Python serialisation helpers
+└── tools/
+    ├── inspection.py  # load / inspect network models
+    ├── simulation.py  # run hydraulic & quality simulations
+    ├── modification.py# in-memory parameter changes
+    └── scenarios.py   # what-if scenario generators (clone + modify + run)
+```
+
+**Session model**: Each loaded network lives in a named session.  Scenario
+tools automatically clone the source session into a new independent session so
+the baseline network is never mutated.
+
+---
+
+## Running the tests
+
+```bash
+pip install pytest
+pytest tests/ -v
+```
+
+---
+
+## Bundled networks
+
+ePyT ships with many standard benchmark networks including Net1, Net2, L-TOWN,
+Hanoi, Anytown, Balerma and others.  Use `list_bundled_networks` to discover
+them all.
+
+---
+
+## License
+
+MIT

epanet_mcp_server-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "epanet-mcp-server"
+version = "0.1.0"
+description = "MCP server for EPANET water distribution network simulation via ePyT"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+keywords = ["epanet", "epyt", "mcp", "water-distribution", "hydraulic-simulation"]
+dependencies = [
+    "mcp>=1.0.0",
+    "epyt>=2.0.0",
+    "numpy>=1.24.0",
+    "pandas>=2.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-asyncio>=0.21",
+    "ruff>=0.1.0",
+]
+
+[project.scripts]
+epanet-mcp-server = "epanet_mcp.server:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"

epanet_mcp_server-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

epanet_mcp_server-0.1.0/src/epanet_mcp/__init__.py

@@ -0,0 +1,3 @@
+"""EPANET MCP Server – ePyT-powered water network simulation tools."""
+
+__version__ = "0.1.0"