Getting started

Installation

The EFD Client is preinstalled in the rubin-env-rsp and rubin-env-developer Conda-Forge metapackages, which is the default Python environment for the Rubin Science Platform. You can check if lsst_efd_client is available at a Python prompt:

import lsst_efd_client

If not available, you can install with Conda:

conda install -c conda-forge lsst-efd-client

Quick start

Instantiate the EFD client from the Rubin Science Platform by specifying the label of the database instance you want to connect to.

To connect to the US Data Facility EFD use the database label usdf_efd:

from lsst_efd_client import EfdClient

client = EfdClient("usdf_efd")
await client.get_topics()

This returns the list of available telemetry topics, confirming that the client is connected successfully.

If you are running the EFD client outside the Rubin Science Platform, see the Authentication guide for instructions on how to configure the connection to an EFD database instance.

Check the guides section and the Python API reference for more information on how to use the EFD client.