Skip to main content

Utility classes for working with the LSST EFD.

Project description

LSST EFD Client

https://img.shields.io/pypi/v/lsst-efd-client.svg https://img.shields.io/travis/lsst-sqre/lsst-efd-client.svg

Utility classes for working with the LSST EFD.

  • Free software: MIT license

Features

  • The client EfdClient, has several useful functions.
    • get_topics: Return the topics in the EFD.
    • get_fields: Return the fields in a particular topic
    • build_time_range_query: Build an InfluxQL query for a topic and time range
    • select_time_series: Return a DataFrame containing results of a time range query
    • select_packed_time_series: Return a DataFrame with high cadence telemetry expanded into a single DataFrame.
    • select_top_n: Return a DataFrame with the results of just the most recent rows.

See example notebooks here.

For more information, see the online docs.

Authentication

Credentials for authenticating to available EFDs are held in a special file on disk. By default, this location is ~/.lsst/notebook_auth.yaml. The file must exist and must have 600 permissions set. To set the correct permissions execute the following command in a shell:

chmod 600 ~/.lsst/notebook_auth.yaml

The format of the file is a YAML dictionary of valid EFD names. Each EFD entry should contain the username, password, and host for the EFD. Currently, my file looks like this:

lab_efd:
  username: <user>
  password: <passwd>
  host: "test-influxdb-efd.lsst.codes"
summit_efd:
  username: <user>
  password: <passwd>
  host: "influxdb-summit-efd.lsst.codes"

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2019-12-23)

  • First release on PyPI.

0.2.0 (2019-01-15)

  • Minimal functionality in place.
  • Docstrings complete.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for lsst-efd-client, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size lsst_efd_client-0.2.2-py2.py3-none-any.whl (9.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size lsst-efd-client-0.2.2.tar.gz (10.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page