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.1.0.tar.gz (16.4 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.1.0-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for wqsurrogatemodels-2.1.0.tar.gz
Algorithm Hash digest
SHA256 202fb1391674b8b9cabcaf3aa24b8e85335a889eb966431f7b1ef9056cb80ec3
MD5 8495ee4077b7e7b5dac65d625cd65a1b
BLAKE2b-256 e25d95c37b96dfff170c556dd576f092210fc5d0295228c91bc7d9535e624392

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for wqsurrogatemodels-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fea0f56680044f3e1848d407a416216688c5dcd2758c1549b7fac82469a8d82a
MD5 d79f8cc8e0f1e74616a0305beb6d905d
BLAKE2b-256 699d9bdd092f5137798a73084a1a2cb98425d68ec84b59ff8324f4fe04c8d172

See more details on using hashes here.

Provenance

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

2.2.0

2 files

This release

2.1.0 This release

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