Skip to main content

A Python client library for the SPICE ice nucleation API

Project description

SPICE Client

A Python client library for interacting with the SPICE API - a system for managing ice nucleation particle experiment data.

Installation

pip install spice-client

Quick Start

from spice_client import ApiClient, Configuration
from spice_client.helpers.wrapper import get_jwt_token
from spice_client.api.default_api import DefaultApi
import pandas as pd
import geopandas as gpd
import json

SERVER = "https://spice.epfl.ch"

auth_token = get_jwt_token(SERVER)
config = Configuration(host=SERVER, access_token=auth_token)
api = DefaultApi(ApiClient(configuration=config))

# List experiments
experiments = api.get_experiments()
print(experiments)

Features

  • Full API coverage for SPICE endpoints
  • Keycloak authentication with token caching
  • Type-safe models and responses
  • Jupyter notebook integration
  • Comprehensive documentation

Authentication

The client includes Keycloak integration for secure API access. Authentication tokens are cached and refreshed.

Documentation

For complete API documentation, visit the live API documentation at https://spice.epfl.ch/api/docs

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

spice_client-0.1.2.tar.gz (62.9 kB view details)

Uploaded Source

Built Distribution

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

spice_client-0.1.2-py3-none-any.whl (120.0 kB view details)

Uploaded Python 3

File details

Details for the file spice_client-0.1.2.tar.gz.

File metadata

  • Download URL: spice_client-0.1.2.tar.gz
  • Upload date:
  • Size: 62.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.9

File hashes

Hashes for spice_client-0.1.2.tar.gz
Algorithm Hash digest
SHA256 f001efce307a0912df54a3766f0fc852dabdc84c323041a29be6d12ed05942c1
MD5 f917e00d7dad4b8055c13d920d11d179
BLAKE2b-256 e141d55b93d68b23e6edad54cf1cae840979dd7381f5474fad4942ae1ea9adba

See more details on using hashes here.

File details

Details for the file spice_client-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for spice_client-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 92a6b59191e1067f0748ea6c18d20eb3c9f09b21ec9477491254342cd027de0d
MD5 cc4c94c7e6ecd3954482ec863cff6fca
BLAKE2b-256 5337d39a7d0092d6037a41f540190bcfbd13788b155939307c8162ba13b0f7c2

See more details on using hashes here.

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