rthym-moc 0.2.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. rthym_moc-0.2.0/CHANGELOG.md +42 -0
  2. rthym_moc-0.2.0/LICENSE +21 -0
  3. rthym_moc-0.2.0/MANIFEST.in +7 -0
  4. rthym_moc-0.2.0/PKG-INFO +1104 -0
  5. rthym_moc-0.2.0/README.md +1072 -0
  6. rthym_moc-0.2.0/pyproject.toml +49 -0
  7. rthym_moc-0.2.0/rthym_moc/__init__.py +79 -0
  8. rthym_moc-0.2.0/rthym_moc/__pycache__/__init__.cpython-312.pyc +0 -0
  9. rthym_moc-0.2.0/rthym_moc/__pycache__/_version.cpython-312.pyc +0 -0
  10. rthym_moc-0.2.0/rthym_moc/__pycache__/epanet.cpython-312.pyc +0 -0
  11. rthym_moc-0.2.0/rthym_moc/__pycache__/report.cpython-312.pyc +0 -0
  12. rthym_moc-0.2.0/rthym_moc/_rthym_moc.cpython-312-x86_64-linux-gnu.so +0 -0
  13. rthym_moc-0.2.0/rthym_moc/_rthym_moc.pyi +120 -0
  14. rthym_moc-0.2.0/rthym_moc/_version.py +3 -0
  15. rthym_moc-0.2.0/rthym_moc/epanet.py +1057 -0
  16. rthym_moc-0.2.0/rthym_moc/report.py +247 -0
  17. rthym_moc-0.2.0/rthym_moc.egg-info/PKG-INFO +1104 -0
  18. rthym_moc-0.2.0/rthym_moc.egg-info/SOURCES.txt +58 -0
  19. rthym_moc-0.2.0/rthym_moc.egg-info/dependency_links.txt +1 -0
  20. rthym_moc-0.2.0/rthym_moc.egg-info/not-zip-safe +1 -0
  21. rthym_moc-0.2.0/rthym_moc.egg-info/requires.txt +22 -0
  22. rthym_moc-0.2.0/rthym_moc.egg-info/top_level.txt +1 -0
  23. rthym_moc-0.2.0/setup.cfg +4 -0
  24. rthym_moc-0.2.0/setup.py +54 -0
  25. rthym_moc-0.2.0/src/bindings.cpp +475 -0
  26. rthym_moc-0.2.0/src/moc_solver.cpp +1628 -0
  27. rthym_moc-0.2.0/src/moc_solver.hpp +314 -0
  28. rthym_moc-0.2.0/src/rthym_moc.js +2 -0
  29. rthym_moc-0.2.0/src/rthym_moc.wasm +0 -0
  30. rthym_moc-0.2.0/src/wasm_bindings.cpp +249 -0
  31. rthym_moc-0.2.0/tests/test_air_valve.py +158 -0
  32. rthym_moc-0.2.0/tests/test_air_valve_dominant_layout_sensitivity_benchmark.py +248 -0
  33. rthym_moc-0.2.0/tests/test_air_valve_dominant_mixed_layout_benchmark.py +250 -0
  34. rthym_moc-0.2.0/tests/test_air_valve_dominant_size_sweep_benchmark.py +250 -0
  35. rthym_moc-0.2.0/tests/test_boundary_variations_and_losses.py +612 -0
  36. rthym_moc-0.2.0/tests/test_check_valve.py +393 -0
  37. rthym_moc-0.2.0/tests/test_column_separation_and_stability.py +113 -0
  38. rthym_moc-0.2.0/tests/test_complex_topology_from_inp.py +182 -0
  39. rthym_moc-0.2.0/tests/test_coverage_boost.py +222 -0
  40. rthym_moc-0.2.0/tests/test_device_placement_benchmark.py +180 -0
  41. rthym_moc-0.2.0/tests/test_gradual_closure_benchmark.py +127 -0
  42. rthym_moc-0.2.0/tests/test_hydropneumatic_size_benchmark.py +174 -0
  43. rthym_moc-0.2.0/tests/test_inp_import_fidelity.py +366 -0
  44. rthym_moc-0.2.0/tests/test_invalid_inputs.py +57 -0
  45. rthym_moc-0.2.0/tests/test_joukowsky_rthym.py +400 -0
  46. rthym_moc-0.2.0/tests/test_long_pipe_valve.py +454 -0
  47. rthym_moc-0.2.0/tests/test_lumped_loss_benchmark.py +253 -0
  48. rthym_moc-0.2.0/tests/test_mixed_device_interaction_benchmark.py +223 -0
  49. rthym_moc-0.2.0/tests/test_multi_device_placement_benchmark.py +204 -0
  50. rthym_moc-0.2.0/tests/test_operational_controls.py +374 -0
  51. rthym_moc-0.2.0/tests/test_pipe_length_benchmark.py +180 -0
  52. rthym_moc-0.2.0/tests/test_pipe_materials.py +137 -0
  53. rthym_moc-0.2.0/tests/test_pipe_minor_losses.py +100 -0
  54. rthym_moc-0.2.0/tests/test_pressure_control_valves.py +390 -0
  55. rthym_moc-0.2.0/tests/test_pump_valve_transients_from_inp.py +289 -0
  56. rthym_moc-0.2.0/tests/test_report.py +105 -0
  57. rthym_moc-0.2.0/tests/test_standpipe_surge_protection.py +387 -0
  58. rthym_moc-0.2.0/tests/test_surge_device_mitigation.py +262 -0
  59. rthym_moc-0.2.0/tests/test_tank_size_benchmark.py +111 -0
  60. rthym_moc-0.2.0/tests/test_wasm_check_valve.py +110 -0
rthym_moc-0.2.0/CHANGELOG.md ADDED
@@ -0,0 +1,42 @@
1
+ # Changelog
2
+
3
+ This project tracks public package versions in `rthym_moc/_version.py` and
4
+ records release-level changes here.
5
+
6
+ The format is based on Keep a Changelog, and this project uses semantic
7
+ versioning for package releases.
8
+
9
+ ## [Unreleased]
10
+
11
+ ### Added
12
+ - `examples/benchmark_matrix.py` performance matrix sweeping time step and
13
+ duration on the standard Joukowsky case (median timings vs TSNet)
14
+
15
+ ### Changed
16
+ - split correctness documentation (`docs/validation.md`) from TSNet performance
17
+ benchmarking (`docs/benchmarking.md`) and restructured README Validation and
18
+ Benchmarking sections accordingly
19
+
20
+ ## [0.2.0] - 2026-05-24
21
+
22
+ ### Added
23
+ - quickstart notebook validation section that overlays the checked-in R-THYM pressure trace, reports RMS/peak benchmark metrics, and documents the benchmark tolerances used by the automated test suite
24
+ - quickstart notebook exploratory plots for the shortened 2-second closure case, including valve-side pressure, flow, closure schedule, peak-check annotations, and reloaded persisted artifacts
25
+ - Binder configuration and README launch path so the quickstart notebook can be opened in a hosted Jupyter environment without a local notebook install
26
+
27
+ ### Changed
28
+ - package metadata now marks the public release line as beta instead of alpha
29
+ - quickstart notebook structure now separates formal benchmark validation from exploratory scenario visualization and keeps the persisted-output workflow reusable from disk
30
+
31
+ ## [0.1.0] - 2026-05-23
32
+
33
+ ### Added
34
+ - initial public alpha release of the RTHYM-MOC Python package and C++ core
35
+ - pybind11-based transient hydraulic solver API with benchmark and validation coverage
36
+ - direct public-surface regressions for `Tank`, `OutflowNode`, and turbine startup behavior
37
+ - focused invalid-input coverage for unknown node types, unknown ids, wrong node kinds, empty schedules, and unsorted schedules
38
+ - benchmark and coverage documentation under `docs/`
39
+
40
+ ### Changed
41
+ - CMake, setuptools, and the Python API now read the package version from the shared `rthym_moc/_version.py` source
42
+ - public docs and coverage tracking now reflect the supported hydraulic boundary/device surface
rthym_moc-0.2.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Jason Lillywhite <jason@lillywhitewater.com>
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
rthym_moc-0.2.0/MANIFEST.in ADDED
@@ -0,0 +1,7 @@
1
+ include setup.py
2
+ include pyproject.toml
3
+ include README.md
4
+ include LICENSE
5
+ include CHANGELOG.md
6
+ graft src
7
+ graft rthym_moc