WQSurrogateModels
wqsurrogatemodels is the installable Python backend for WQI5-based current-state
water quality assessment.
Install
pip install wqsurrogatemodels
The package requires Python 3.10 or newer. Optional surrogate-model libraries are available with:
pip install "wqsurrogatemodels[models]"
Use the direct WQI5 baseline
from wqsurrogatemodels import direct_wqi5_score
score = direct_wqi5_score(do=7.2, bod=2.1, nh3n=0.3, ec=450, ss=12)
Run the API
uvicorn wqsurrogatemodels.api:app --host 0.0.0.0 --port 8001
The primary HTTP contract is under /api/v2/*. Datasets and trained surrogate
artifacts are supplied separately and are not included in the PyPI distribution.
Set PROJECT_ROOT to the directory containing local data/ and models/
directories when running the API outside a source checkout.
Package boundary
The distribution contains the runtime package, dependency metadata, this description, and the Apache 2.0 license. It excludes research datasets, serialized model binaries, generated results, experiment configurations, reproducibility scripts, repository-only tests, and research documentation.
Repository and API documentation: https://github.com/KageRyo/WQSurrogateModels
1 maintainer
Metadata
1 maintainer
Release files for wqsurrogatemodels 2.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| wqsurrogatemodels-2.2.2.tar.gz | 25.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| wqsurrogatemodels-2.2.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 50.7 kB
Release files / wqsurrogatemodels-2.2.2.tar.gz
| Download URL | wqsurrogatemodels-2.2.2.tar.gz |
|---|---|
| Size | 25.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
62c9271da8413d19740854ad1ace772c31c3a47fc030f097aebea4fc8d597a3e
|
|
BLAKE2b-256 checksum How to use checksums |
f0c87daac819016b71d25615aa6f1ac52f95786683c6df97fe974d0eb3f70f3d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.
Transparency logRelease files / wqsurrogatemodels-2.2.2-py3-none-any.whl
| Download URL | wqsurrogatemodels-2.2.2-py3-none-any.whl |
|---|---|
| Size | 25.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
58e74d59ecec625b7d591bd5829734c51a589039ef17e344c2a49130f402304b
|
|
BLAKE2b-256 checksum How to use checksums |
cee1662d9a3cd2e174cf71069fb664d4e6888c6b9a37c70c8684ba057c9077a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.
Transparency log
