gravi-model-client

Python client for Gravitate's demand and supply optimization models.

Installation

pip install gravi-model-client

Usage

from gravi_model_client import GraviModelClient, ModelRunRequest, OptimizationInput

async with GraviModelClient(api_key="your-api-key", base_url="https://...") as client:
    # Health check
    await client.health_check()

    # Run demand model (synchronous)
    result = await client.run_demand_model(request)

    # Run TSD (supply) model (synchronous)
    result = await client.run_tsd_model(optimization)

Async (queue-based) models: VRP and OSA

VRP (tank wagon turn) and OSA (order-based supply) runs are queued and processed by a worker. run_vrp_model / run_osa_model handle the whole queue → poll → fetch lifecycle and block until the result is ready:

from gravi_model_client import GraviModelClient, VrpModelRunRequest, OsaInput

async with GraviModelClient(api_key="your-api-key") as client:
    vrp_result = await client.run_vrp_model(vrp_request)   # -> VrpModelResultResponse
    osa_result = await client.run_osa_model(osa_input)     # -> OsaAPIResponse

They raise ModelRunError if the run fails or is cancelled, and ModelRunTimeout if it doesn't finish within timeout (default 300s; tune poll_interval too).

For fire-and-forget / webhook workflows, use the primitives instead: queue_vrp_model returns a job id, get_job_status / get_osa_job_status return a JobStatus, and get_vrp_model_run_response / get_osa_model_run_response fetch the finished result.

Models

This package is the single source of truth for all pydantic models used by both the client and the server. Import models directly:

from gravi_model_client.demand import ModelRunRequest, StoreRequest, TankRequest, VolumeRange
from gravi_model_client.tsd import OptimizationInput, Directive, Site, Tank

Download files

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

Source Distribution

gravi_model_client-0.8.0.tar.gz (37.6 kB view details)

Uploaded Aug 22, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

gravi_model_client-0.8.0-py3-none-any.whl (28.6 kB view details)

Uploaded Aug 22, 2026 Python 3

File details

Details for the file gravi_model_client-0.8.0.tar.gz.

File metadata

Download URL: gravi_model_client-0.8.0.tar.gz
Upload date: Aug 22, 2026
Size: 37.6 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for gravi_model_client-0.8.0.tar.gz
Algorithm	Hash digest
SHA256	`1dbd8a5773336c68ee57430e2d95157c342fe2c6eae6aa67b2db7a3a4fe404f6`
MD5	`791a85191ad877faae4b4c41c66f41f4`
BLAKE2b-256	`edd2cdcf059f7a6db9595ca7681259c7e640b02812c910b58bfabc78076afd08`

See more details on using hashes here.

Provenance

The following attestation bundles were made for gravi_model_client-0.8.0.tar.gz:

Publisher: publish-gravi-model-client.yml on gravitate-energy/demand_only_model

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: gravi_model_client-0.8.0.tar.gz
- Subject digest: 1dbd8a5773336c68ee57430e2d95157c342fe2c6eae6aa67b2db7a3a4fe404f6
- Sigstore transparency entry: 2559442993
- Sigstore integration time: Aug 22, 2026
Source repository:
- Permalink: gravitate-energy/demand_only_model@dece1e9335e9c73755575908bc4b3a8e81cd5e70
- Branch / Tag: refs/tags/gravi-model-client-v0.8.0
- Owner: https://github.com/gravitate-energy
- Access: private
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish-gravi-model-client.yml@dece1e9335e9c73755575908bc4b3a8e81cd5e70
- Trigger Event: push