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.1.6.tar.gz (11.5 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.1.6-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gravi_model_client-0.1.6.tar.gz
  • Upload date:
  • Size: 11.5 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.1.6.tar.gz
Algorithm Hash digest
SHA256 db4c3c33b7358472774330bd6fbc6a7f28bad080365163b41312b281c5ac65cd
MD5 42351fdc79e2b917bc42d22e2f05c65c
BLAKE2b-256 b9300439dc2cda5ce8f52924e976f4dc8dee7ef42f433ebfcbc45cfce5c3d44f

See more details on using hashes here.

Provenance

The following attestation bundles were made for gravi_model_client-0.1.6.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.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for gravi_model_client-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 78663f1175954ccfed0a600696115f2b5b150743d48d64f3217505ec03af41f1
MD5 371828ac6d94b3fa01f583a2f4426774
BLAKE2b-256 91b860dce10f475776c32ec65a403f48c7fc32375dfd51812c4a3ff9182300fe

See more details on using hashes here.

Provenance

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