Run

main is the main executable function to pass through the pytimeops workflow.

Example:

result = pytimeops.main('input.csv', 20, "a note about the metadata", verbose=False)

Overview:

pytimeops.run.main(inputCSV, time_interval, comments, verbose=False)[source]

This main function performs the workflow: 1. takes the csv file input from the command line

and reads it into the dataset/Timeseries format. print out some properties to sanity check

  1. cleans bad recordings / removes un-needed channels

  2. produces some versions with different binning

Parameters:

  • inputCSV (str) – of full path to .csv input file

  • verbose (bool) – Additional debugging printouts if True

  • time_interval (float) – width of each bin = time between measurements

  • comments (str) – any comments about dataset to store as global metadata

Returns:

void

Command line options for running run.py:

run.py

usage: run.py [-h] [-v] [-i INPUTCSV] [-c COMMENTS] [-t TIME_INTERVAL]
-h, --help

show this help message and exit

-v, --verbose

verbose output

-i <inputcsv>, --inputCSV <inputcsv>

Path to csv file to read in

-c <comments>, --comments <comments>

Comments on dataset for metadata

-t <time_interval>, --time_interval <time_interval>

[ms] time interval / binwidth