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"

CONTRIBUTING

For information on contributing to this project see this page.

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.

0.3.0 (2019-01-31)

  • Unit tests added.

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

lsst-efd-client-0.4.0.tar.gz (131.5 kB view details)

Uploaded Source

Built Distribution

lsst_efd_client-0.4.0-py2.py3-none-any.whl (9.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file lsst-efd-client-0.4.0.tar.gz.

File metadata

  • Download URL: lsst-efd-client-0.4.0.tar.gz
  • Upload date:
  • Size: 131.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.7.1

File hashes

Hashes for lsst-efd-client-0.4.0.tar.gz
Algorithm Hash digest
SHA256 51f8f05251142db479338c22cbbcd5d9868c76ec2363ab837e95bb800a1eb802
MD5 bf7a14bc23a366e4fa63d49f8648f1de
BLAKE2b-256 098887ade49f6ad6c163746b3ef892ceb864fbf6300f49b0926cce21efa0bfcd

See more details on using hashes here.

File details

Details for the file lsst_efd_client-0.4.0-py2.py3-none-any.whl.

File metadata

  • Download URL: lsst_efd_client-0.4.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.7.1

File hashes

Hashes for lsst_efd_client-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 07e9a0f1e801e5805df1102f92ddb3890cdf28b02b86c989f0daaafcf2ed238c
MD5 fcdf14fe3c85faded98b9febe591da1e
BLAKE2b-256 b505c04f7bc850e7bb8ac4a3a7e70e84b17b9daadaad7d3e65504cf6ae49d55f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page