Skip to main content

Python client for Gravitate's Demand & Supply optimization models

Project description

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
    result = await client.run_demand_model(request)

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

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

Project details


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.3.0.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

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

gravi_model_client-0.3.0-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gravi_model_client-0.3.0.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gravi_model_client-0.3.0.tar.gz
Algorithm Hash digest
SHA256 4ee4027071397070c503e567c58cc2c02ccad18f6ac869478ba5341138821951
MD5 7c73e69e0aa7c1b686be2628baf6864c
BLAKE2b-256 80b71e47e278ff82012a763453ec8979b1e59efde53a088951a39c21a0dd69ac

See more details on using hashes here.

Provenance

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

File details

Details for the file gravi_model_client-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for gravi_model_client-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 60a5f6c4c1d4b65e59159f773555149e040bfbf490667b5bc198048c75d4870b
MD5 ca5fd81fe7bbbb76fecca7ec00250044
BLAKE2b-256 a6153fb04e516fa09bc5880e6a7bd9f1e32eb0536c96179ce9d3ce7663539014

See more details on using hashes here.

Provenance

The following attestation bundles were made for gravi_model_client-0.3.0-py3-none-any.whl:

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.

Supported by

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