Metadata-Version: 2.1
Name: openswmm-gpu-omp
Version: 6.0.0a2
Summary: OpenMP (Kokkos) GPU-plugin companion for the OpenSWMM 2D surface solver.
Keywords: SWMM,stormwater,hydraulics,GPU,OpenMP,Kokkos
Author-Email: Caleb Buahin <caleb.buahin@gmail.com>
Maintainer-Email: Caleb Buahin <caleb.buahin@gmail.com>
License: MIT License
         
         Copyright 2026 Caleb Buahin
         
         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.
         
         This project contains original material has been released as part of various USEPA SWMM software over the years. These reside in the 
         public domain and cannot be claimed. This project also contains new material prepared by the United States
         Government for which domestic copyright protection is not available under 17
         USC § 105.
         
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Programming Language :: C++
Classifier: Topic :: Scientific/Engineering :: Hydrology
Project-URL: Homepage, https://github.com/hydrocouple/openswmm.engine
Project-URL: Repository, https://github.com/hydrocouple/openswmm.engine
Requires-Python: >=3.10
Requires-Dist: openswmm==6.0.0a2
Description-Content-Type: text/markdown

# openswmm-gpu-omp

OpenMP (Kokkos) acceleration companion for the [OpenSWMM](https://pypi.org/project/openswmm/)
2D surface solver.

The base `openswmm` wheel is CPU-only and fully portable (Kokkos-free). This
companion ships a single native plugin (`libopenswmm_gpu_omp`) that the OpenSWMM
engine discovers and loads at runtime to run the 2D surface solver on the
Kokkos-OpenMP backend.

## Install

```bash
pip install openswmm            # CPU-only base engine
pip install openswmm-gpu-omp    # add OpenMP acceleration
```

That is all. There is no public Python API: at import, the base `openswmm`
package detects this companion and adds it to the engine's plugin search path
(`OPENSWMM_GPU_PLUGIN_PATH`). With `OPENSWMM_2D_BACKEND` left at its `auto`
default, 2D surface runs then use OpenMP automatically. Setting
`OPENSWMM_2D_BACKEND=cpu` forces the serial solver; uninstalling this package
reverts to it permanently.

## Notes

- OpenMP only — no GPU driver required. Numerics match the serial CPU solver to
  ~1e-13 (not bit-identical); pin `OPENSWMM_2D_BACKEND=cpu` where bit-exact
  reproducibility is required.
- The plugin is version-locked to the base engine (`openswmm == <same version>`)
  and additionally ABI-checked at load time.

See `docs/2D_GPU_DEFAULTS.md` in the engine repository for the full
backend-selection matrix.
