Skip to main content

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wqsurrogatemodels-2.2.0.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wqsurrogatemodels-2.2.0-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

Details for the file wqsurrogatemodels-2.2.0.tar.gz.

File metadata

  • Download URL: wqsurrogatemodels-2.2.0.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for wqsurrogatemodels-2.2.0.tar.gz
Algorithm Hash digest
SHA256 af72a4848520007723dc714cbcecd70d119d001919b11123b9b27c0fb2b6637d
MD5 bcddade45ca0cc83a01ef8966e8d64f7
BLAKE2b-256 0f26a483dab3920367b027681a12fc9dce25d7bec1feabb16d4ff1a9f3c623c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for wqsurrogatemodels-2.2.0.tar.gz:

Publisher: release.yml on KageRyo/WQSurrogateModels

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file wqsurrogatemodels-2.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for wqsurrogatemodels-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e8beb596104fb5de5504d7366be5d585a28749eb1196ecb6afb293a32c72710a
MD5 a2e63c803eb6a7efaeb0df4a901e8f8d
BLAKE2b-256 b2e1094f99e0b37d8bf98ddf7758a1d6af7e1032f788c34fd49bac379571da3e

See more details on using hashes here.

Provenance

The following attestation bundles were made for wqsurrogatemodels-2.2.0-py3-none-any.whl:

Publisher: release.yml on KageRyo/WQSurrogateModels

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

2.2.1

2 files

This release

2.2.0 This release

2 files

2.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page