added documentation for data_ac.py

Author: rushk014

plotting_test/data_ac.py

@@ -9,10 +9,14 @@
 import os, sys, csv, re, math
 import numpy as np
 
+# flag for if we should stop the program
 stop_requested = False
+# bc channel corrective value
 bc_correction = 0.88
+# instrument dictionary - initialized instruments are automatically added
 instruments = []
 
+# generate a serial connection with DEVICE over baudrate BAUDRATE
 def serialGeneric(device,baudrate):
 	ser = serial.Serial(port=device,
 		baudrate=baudrate,
@@ -22,6 +26,8 @@ def serialGeneric(device,baudrate):
 	)
 	return ser
 
+
+# signal handler for ctrl-c (quit)
 def sig_handler(signum, frame):
 	sys.stdout.write("handling signal: %s\n" % signum)
 	sys.stdout.flush()
@@ -30,6 +36,8 @@ def sig_handler(signum, frame):
 	stop_requested = True
 
 class Instrument(object):
+
+	# initialize instrument with serial connection and add it to instrument dict
 	def __init__(self, comport, baudrate):
 		if comport:
 			self.serial = serialGeneric(comport, baudrate)
@@ -42,6 +50,7 @@ def __str__(self):
 	def __repr__(self):
 		return self.__str__()
 
+	# dumps the serial output SER, which was received at datetime DT, into rawraw_data.csv
 	def dumpserial(self, ser, dt):
 		with open(filepath + 'rawraw_data.csv', mode='ab') as rawFile:
 			fcntl.flock(rawFile, fcntl.LOCK_EX)
@@ -50,6 +59,7 @@ def dumpserial(self, ser, dt):
 			fcntl.flock(rawFile, fcntl.LOCK_UN)
 		return
 
+	# continually call Instr get_values() func to receive serial output until STOP_REQUESTED
 	def run(self, queue):
 		while not stop_requested:
 			values = self.get_values()
@@ -62,6 +72,9 @@ def run(self, queue):
 		if stop_requested:
 			self.serial.close()
 
+	# def get_values(self):
+	# exists for each defined instrument below, parses serial output to a datetime and value (sometimes includes attn and flow)
+
 # BC Instr
 
 class AE33_Instrument(Instrument):
@@ -411,21 +424,25 @@ def get_values(self):
 			return None
 		return nox_values
 
+# main method for use when file is run through multiprocessing (like in this ../cli.py)
 def main_wrapper(q):
 	global filepath
 	filepath = q.get()
 
+	# create output dir using filepath (sent to queue Q from plotter.py)
 	if not os.path.exists(os.path.dirname(filepath)):
             try:
                 os.makedirs(os.path.dirname(filepath))
             except OSError as exc: # Guard against race condition
                 if exc.errno != errno.EEXIST:
                     raise
 
+    # initialize rawraw_data.py header
 	with open(filepath + 'rawraw_data.csv', mode='wb') as rawFile:
 		rawData = csv.writer(rawFile, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL)
 		rawData.writerow(['Timestamp', 'Instr', 'S#', 'Message'])
 
+	# dictionary mapping serial numbers to Instrument objects ** CHANGE THIS TO ADD MORE INSTRUMENTS **
 	comport_dict = {
 		'FTXP6UA4': AE33_Instrument,
 		'FTXP9NHN': AE16_Instrument,
@@ -451,6 +468,8 @@ def main_wrapper(q):
 	comport_pattern = re.compile('\/dev\/cu\.usbserial(\-(.)*)?$')
 	serial_comlist = []
 
+	# initialize instrument objects for each serial connection (view in terminal with ls /dev/cu.*) that matches 
+	# comport_pattern (/dev/cu.usbserial- or /dev/cu.wchusbsereial for ABCD)
 	for element in comlist:
 		if comport_pattern.match(element.device):
 			try:

plotting_test/plotter.py

@@ -374,13 +374,10 @@ def draw(self):
         #     self.update_ambient()
         #     self.ambient_cs = 5
 
-        update_am = time.time()
-        row.append(update_am - getUpdate)
-
         # plume analysis and summary write
         self.analyze(current_time)
         analyze = time.time()
-        row.append(analyze - update_am)
+        row.append(analyze - getUpdate)
         self.write_ts(current_time)
         write_summ = time.time()
         row.append(write_summ - analyze)
@@ -698,7 +695,6 @@ def get_plume_area(self, ts_dict, chan_spec, chan_id):
 
     def get_ts_dict(self, start_time, stop_time):
         ret = collections.OrderedDict()
-        print(start_time, stop_time)
         t = start_time
         while t != stop_time:
             ret[t] = self.ts_aligned_dps[t]
@@ -830,6 +826,9 @@ def reset_data(self, plot, name):
             plot.set_ylabel(r'$\mu g/m^3$')
             plot.set_xlabel('seconds ago')
         plot.tick_params(axis='y', left=True, right=True, labelright=True)
+        # draw analysis horizons
+        plot.axvline(45, c='b', linewidth=0.5, linestyle='--')
+
 
     def correct_ts(self, timestamps, chan, instr_id):
         start_lag = self.pip[chan][instr_id]['start_lag']