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.

    • get_schema: Get metadata for the fields in a particular topic.

  • There are also some utilities for dealing with results of queries

    • merge_packed_time_series: Takes a dataframe with records that have multiple samples per entry and returns a dataframe with one record per sample.

    • rendezvous_dataframes: Extend on dataframe with data from another dataframe using the closest record in time in the past, in the future, or nearest overall.

See example notebooks here.

For more information, see the online docs.

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.

0.4.0 (2019-01-31)

  • Very minor doc updates.

  • Accidently pushed minor version when patch was meant.

0.5.0 (2020-05-29)

  • Switch to the segwarides based credentials.

0.6.0 (2021-02-11)

  • Fix bug in listing possible endpoints

  • Add some utility functionality and speed up unpacking packed time series (thank you RHL)

0.6.4 (2021-02-15)

  • Fix a regression that causes an exception when the name of one column is the same as the start of the name of another column

  • Add a test for the regression

0.7.0 (2021-03-24)

  • Add the get_schema method to fetch metadata about topic fields

  • Add a test for the schema parser

0.8.2 (2021-05-25)

  • Deal gracefully with topics that have no description or units (Thanks Angelo!)

  • Add add a parameter to allow a time threshold when selecting top N (Thanks Michael!)

0.8.3 (2021-06-11)

  • Add column specifying if a field in the schema is array-like.

  • Check for both conventions indicating unitless columns when creating astropy units.

0.9.0 (2021-10-05)

  • This changes the convention to using UTC as the internal representation. This mirrors a change in the influxDB to store index timestamps as UTC. There is a switch to convert the index from TAI to UTC, but the default is to assume UTC everywhere.

0.9.1 (2021-10-28)

  • Fix various bugs left over from the UTC conversions. The most important of these is correcting how the index for packed time series is handled. The other is in the implementation fow how we attempt to handle legacy databases with the index still in TAI.

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.9.1.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

lsst_efd_client-0.9.1-py2.py3-none-any.whl (12.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: lsst-efd-client-0.9.1.tar.gz
  • Upload date:
  • Size: 2.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.1

File hashes

Hashes for lsst-efd-client-0.9.1.tar.gz
Algorithm Hash digest
SHA256 0f8708baa15a112d9b8bde9e8872feed6df403791485357f45d94d41dd52de6f
MD5 3ac9325b2ffbd74bad6d61662514bfc3
BLAKE2b-256 5a91ec0b2c32131d627bc20c622c46b7bdf787840350680435d4ada2f9c9d8ad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lsst_efd_client-0.9.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.1

File hashes

Hashes for lsst_efd_client-0.9.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 363212365f0011b0f5aae913060f198e725377bd7551211e1816ac26bd967a9f
MD5 8d3b0d5f0e66a06914e09b8d95db6ca0
BLAKE2b-256 038409188a989e017921081402523c2deb0e27ae4055a597a0948bba08354a76

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