hamsci_psws.grape1.DataInventory

class hamsci_psws.grape1.DataInventory(nodes=None, G=None, freq=None, sTime=None, eTime=None, data_path='data', suffix='.csv')[source]

Bases: object

__init__(nodes=None, G=None, freq=None, sTime=None, eTime=None, data_path='data', suffix='.csv')[source]

Create an inventory of availble grape1 data in the data_path. Inventory will be dataframe df attached to DataInventory object.

data_path: location of grape1 data suffix: suffix of data files. Defaults to ‘.csv’

Methods

__init__([nodes, G, freq, sTime, eTime, ...])

Create an inventory of availble grape1 data in the data_path.

filter([nodes, G, freq, sTime, eTime])

Filter data by parameters.

get_nodes()

Return a list of all of the unique node numbers in the inventory.

plot_inventory([html_out])

Generate a plot of the data inventory using plotly.
filter(nodes=None, G=None, freq=None, sTime=None, eTime=None)[source]

Filter data by parameters. The filtered results will be returned and stored in self.df. Unfiltered results will always be available in self.df_unfiltered.

Parameters

  • nodes (node numbers (int or list of ints)) –

  • G (type of receiving station (string or list of strings)) – G – Grape (Low Cost Platform) 1 – Generation 1 (has 1 receiver) 2 – Generation 2 (has 4 receivers) T – Tangerine (High Performance Platform) 1 – Generation 1 2 – Generation 2 S – Standard / Commercial (Amateur) Hardware (details in Metadata) U – User Custom Hardware (details in Metadata) N – No radio collectiopn – instrument(s) only – defaults to N0

  • freq (frequency in Hz (float or list of floats)) –

  • sTime (UTC starting time of observations (datetime object)) –

  • eTime (UTC ending time of observations (datetime object)) –

get_nodes()[source]

Return a list of all of the unique node numbers in the inventory.

plot_inventory(html_out='inventory.html')[source]

Generate a plot of the data inventory using plotly.

html_out: Filename of html-version of data inventory plot.