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.2.1.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.2.1-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gravi_model_client-0.2.1.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.2.1.tar.gz
Algorithm Hash digest
SHA256 e8559fa55c5fbcb0c51cbf3fcd5ad5e0db72aa7bc582aea7653ffb87705ab256
MD5 f0a7ba978b08b27de52e07de47dce319
BLAKE2b-256 4d92b1a8b431a6e66d62a680fe66762ce7bd2e6fc5a7c975a7d8116308eef732

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for gravi_model_client-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 53f2ab4e7c3ce5d8c19b9b3d738eff74c9c034ea0f0a2c97b768a148f56338a8
MD5 3344a5fd5c4a9c1eff450fd602983b22
BLAKE2b-256 a674643db9138170d16f8c612e6f28638c674498194b5e77769b72f07e3d8e8d

See more details on using hashes here.

Provenance

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