lsst.rsp — Python utilities

The lsst.rsp package provides Python helpers for working inside the Rubin Science Platform Notebook aspect. These utilities handle common tasks such as connecting to the platform’s TAP service, retrieving access tokens, and interacting with other RSP services. For example, the get_tap_service() helper returns a ready-to-use client for querying LSST catalogs:

from lsst.rsp import get_tap_service

service = get_tap_service("tap")

The lsst.rsp package is pre-installed in the RSP Notebook environment, so it is available to import in any notebook or terminal session without additional setup.

This reference documents the latest released version of lsst.rsp. To use the package outside the RSP — for example, on a local machine — install it from PyPI:

pip install lsst-rsp

lsst.rsp Package

Collection of utilities for Rubin Science Platform notebooks.

Functions

get_access_token([tokenfile, log])	Get the Gafaelfawr access token for the user.
get_catalog()	Call get_tap_service("tap") (deprecated alias).
get_datalink_result(result)	Return the datalink part of a result.
get_digest()	Return the digest of the current Docker image.
get_hostname()	Return hostname or, failing that, localhost.
get_influxdb_credentials(label[, token])	Get the credentials for an InfluxDB database.
get_influxdb_location(label)	Get the location information for an InfluxDB database.
get_node()	Return the name of the current Kubernetes node.
get_obstap_service()	Call get_tap_service("live") (deprecated alias).
get_pod()	Get the name of the running pod (deprecated, not functional).
get_query_history([limit, token])	Retrieve the UWS IDs of the user's most recent TAP queries.
get_service_url(service, dataset)	Get the API URL for a service and dataset combination.
get_siav2_service(data_release)	Construct an SIA2Service client.
get_tap_service(*args)	Construct a TAP service instance for the requested TAP service.
list_datasets()	List the available datasets in this environment.
list_influxdb_labels(*[, local])	List the available InfluxDB labels in this environment.
retrieve_query(query_url)	Retrieve job corresponding to a particular query URL.

Classes

DiscoveryNotAvailableError(exc)	Service discovery information is not available.
InfluxDBCredentials(url, database, ...)	InfluxDB database location information and credentials.
InfluxDBLocation(url, database, schema_registry)	Location information for an InfluxDB database.
InvalidDiscoveryError(exc[, label])	Discovery information is malformed.
RSPClient(service_endpoint[, token])	Configured client for other services in the RSP.
RSPDiscovery(dataset, *[, discovery_url, token])	Look up Rubin Science Platform services and construct clients.
TokenNotAvailableError	No Gafaelfawr token is available.
UnknownDatasetError(dataset)	Requested dataset is not present in this environment.
UnknownInfluxDBError(label)	Requested dataset is not present in this environment.
UnknownServiceError(service[, dataset])	Requested service is not present in this environment.

Class Inheritance Diagram