ucnhistory 0.3.2

Read data from ucn history table

ucnhistory

Fetch UCN history measurements from SQL database on daq01.ucn.triumf.ca as a pandas DataFrame. Allows for user-friendly timestamp input and write table to csv.

Installation

Clone and install by the following

git clone https://github.com/ucn-triumf/ucnhistory.git
cd ucnhistory
pip install .

which will install the files on the user's python path. One can then import the package from anywhere on the device.

Documentation and Examples

See here for reference

Command line usage:

Help message:

usage: ucnhistory [-h] [-t TABLE] [-s START] [-e END] [-o OUTPUT] [-lt] [-lc] [-c COLUMN]

Fetch tables from ucn history SQL database to csv file

options:
  -h, --help            show this help message and exit
  -t TABLE, --table TABLE
                        Name of table from which to fetch
  -s START, --start START
                        Specify range start date and time
  -e END, --end END     Specify range end date and time
  -o OUTPUT, --output OUTPUT
                        Specify name of output csv file
  -lt, --list_tables    Display tables in database
  -lc, --list_columns   Display columns in database table (must specify table)
  -c COLUMN, --column COLUMN
                        Fetch column from table, use multiple times to get multiple columns. If
                        absent, fetch all columns

Some example usage:

# fetch an table from the past 24h nd save with default filename
ucnhistory -t ucn2epics_measured

# list all available tables
ucnhistory -lt

# list all columns in a table
ucnhistory -lc -t ucn2epics_measured

# get one table for a specified time period
ucnhistory -t ucn2epics_measured -s 'June 6 2024 12pm' -e 'June 6 2024 1pm'

Notes

Database access

Note that access to the database requires the use of a password. This password should be stored in the python keyring in the following way:

import keyring
keyring.set_password("ucn_history", "ucn_reader", password)

The password should be obtained from someone within the group.

SSH access

Access to the DAQ computer is provided by mean of an SSH tunnel. One should copy their public key for password-less access to the machine.

ssh-copy-id [e-mail]