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

Uploaded Python 3

File details

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

File metadata

  • Download URL: spice_client-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 c8df9fdc9cac54aaef76dfc4fed283441d7eee6a157ab5d68885a6f7c00cd614
MD5 c70259a6bc8729235148a7f93749f090
BLAKE2b-256 cd7113a0e3164e3101a95609a8c500f617c47bc882e0d53e9bb5aca538c0c641

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for spice_client-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5a88261c1dd8fd0445147f72c1d68c1cd83a6b43f2a510d613f9d08f6fd01c69
MD5 e5c15959adbe189bd687938d386dc02e
BLAKE2b-256 cb978d62ed078cfe19bf24af4d59cebbb01bd697c03e31d1a6c602321eef351e

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