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.3.tar.gz (61.0 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.3-py3-none-any.whl (117.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for spice_client-0.1.3.tar.gz
Algorithm Hash digest
SHA256 aa18faf8121a88931097b2335540b463c4157e97326c91bef2080ac736e81ef8
MD5 5a3071b75b618bec81d49c7a1a667e26
BLAKE2b-256 f1b590055934b1ca0f0e2e18167b3a9ea65af2d865d47bbed821e4f407488b17

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for spice_client-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 73234dfb9ccdc8ab3cdd1c039fd15701316aa8a50a49ed0a8bf97fa9ebaee5dc
MD5 22990c3793db903b218cf30df72a87f4
BLAKE2b-256 a2d91d38ea8ac0462e8321bff6320c49d8f878647377b2d2b517ee10134f0c76

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