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.1.tar.gz (25.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.1-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wqsurrogatemodels-2.2.1.tar.gz
  • Upload date:
  • Size: 25.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.1.tar.gz
Algorithm Hash digest
SHA256 e1c9593e9d25d9c4356902f8fcd57fd25675db616413064c1be766afd9a577d2
MD5 1e42b1d3e6123753df36ea2746e911cd
BLAKE2b-256 cb3e95455396468271a44a1cf590eee2eae3aea0858b34c3d0429aa4e9110bdd

See more details on using hashes here.

Provenance

The following attestation bundles were made for wqsurrogatemodels-2.2.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for wqsurrogatemodels-2.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 84ecafe8f5531a99e058e5caf9cc1d080ed302742b12dc61c787612ebe728efc
MD5 4258cd39fade846941caa3933de72a3b
BLAKE2b-256 c929e28cda3a144eb6036755711ee4695814c129ece25d65f8494e2b24636648

See more details on using hashes here.

Provenance

The following attestation bundles were made for wqsurrogatemodels-2.2.1-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

This release

2.2.1 This release

2 files

2.2.0

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