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 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.1.tar.gz (62.8 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.1-py3-none-any.whl (118.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for spice_client-0.1.1.tar.gz
Algorithm Hash digest
SHA256 43f5f01482e17055a143082fc0e7baba8062c365fec7493a603f8d2008692cfa
MD5 9786c55d83aad5f2934153edc5bee930
BLAKE2b-256 e8ac572dd9c4625000278ef4aab9358ac21ec6969f5967156a7b3c1cf4390f73

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for spice_client-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5fe70ade8a3e9638c70c1979def3d9c7b6503f923b116ea7ee0f9c9db0b5e468
MD5 1427a1fd4a39beb030b81e454fca5683
BLAKE2b-256 783f7c2836fbc1ed9ab535d6c047f1dd8b9ba62abca39a395fe0a6855d4b55df

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