tottag 1.1.0__tar.gz

tottag-1.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include dashboard/*.ico
+include dashboard/*.png

tottag-1.1.0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: tottag
+Version: 1.1.0
+Summary: TotTag Management Dashboard
+Home-page: https://github.com/lab11/socitrack
+Author: Will Hedgecock
+Author-email: ronald.w.hedgecock@vanderbilt.edu
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+Requires-Dist: bleak
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pytz
+Requires-Dist: scipy
+Requires-Dist: pyserial
+Requires-Dist: babel
+Requires-Dist: tzlocal
+Requires-Dist: tk
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+TotTag Management Dashboard
+===========================
+
+Overview
+--------
+
+This directory contains all source code for the TotTag Management Dashboard. All setup and preparation for live pilot testing should be carried out through the TotTag Dashboard.
+
+
+Installation
+------------
+
+The easiest way to install this tool is through `pip` by entering:
+
+``python3 -m pip install tottag``
+
+If you wish to install the package manually or develop it further, you should first clone the `SociTrack repository <https://github.com/lab11/socitrack>`_ to
+your hard drive, `cd` into the ``software/management`` directory, then issue the following command in a terminal:
+
+``python3 -m pip install -e .``
+
+
+Usage
+-----
+
+Once installed, the management dashboard is accessible from any terminal by entering the following command:
+
+``tottag``
+
+You do not need to navigate to the SociTrack source code directory to run the application.
+
+Usage of the TotTag Dashboard should be relatively straightforward, keeping in mind a few caveats:
+
+•	A TotTag device is only discoverable and visible if it is currently being charged. If the device is not on a charger, it will not appear in the TotTag Dashboard.
+•	You will not be able to carry out any management functionality unless you are actively connected to a TotTag, so if the action buttons are grayed out, ensure that you are actually connected to a device.
+•	If, at any time, the application freezes or becomes unresponsive, you can always force it to close by returning to the terminal in which you entered the “tottag” command and simultaneously pressing CTRL+C. This should cause the application to forcefully terminate.
+
+The suggested procedure for setting up a pilot deployment is the following:
+
+1.	Determine exactly how many TotTags will be needed for the deployment, and choose this number of devices to set aside.
+2.	Make a note on a piece of scratch paper about which Device IDs should be associated with which user-friendly labels.
+3.	Open the TotTag Dashboard and go to the “Deployment” tab. Do not connect to any TotTags at this time.
+4.	Enter all relevant information about the upcoming deployment, including the mapping of TotTag labels to Device IDs.
+5.	Once all information has been entered, ensure that all relevant TotTags are discoverable in the device bar at the top of the dashboard.
+6.	Click the “Start” button to start the deployment programming process for all relevant devices.
+7.	Once complete, it is a good idea to individually connect to each of the participating devices and verify that both the current time and the experiment details are correct.
+
+After the above steps have been completed, your devices are ready for shipment and will automatically shut down until time for the deployment to begin. Upon completion of a pilot test, the first thing you should do upon receipt of the TotTags is to download all log files before putting the TotTags back into storage.

tottag-1.1.0/README.rst

@@ -0,0 +1,48 @@
+TotTag Management Dashboard
+===========================
+
+Overview
+--------
+
+This directory contains all source code for the TotTag Management Dashboard. All setup and preparation for live pilot testing should be carried out through the TotTag Dashboard.
+
+
+Installation
+------------
+
+The easiest way to install this tool is through `pip` by entering:
+
+``python3 -m pip install tottag``
+
+If you wish to install the package manually or develop it further, you should first clone the `SociTrack repository <https://github.com/lab11/socitrack>`_ to
+your hard drive, `cd` into the ``software/management`` directory, then issue the following command in a terminal:
+
+``python3 -m pip install -e .``
+
+
+Usage
+-----
+
+Once installed, the management dashboard is accessible from any terminal by entering the following command:
+
+``tottag``
+
+You do not need to navigate to the SociTrack source code directory to run the application.
+
+Usage of the TotTag Dashboard should be relatively straightforward, keeping in mind a few caveats:
+
+•	A TotTag device is only discoverable and visible if it is currently being charged. If the device is not on a charger, it will not appear in the TotTag Dashboard.
+•	You will not be able to carry out any management functionality unless you are actively connected to a TotTag, so if the action buttons are grayed out, ensure that you are actually connected to a device.
+•	If, at any time, the application freezes or becomes unresponsive, you can always force it to close by returning to the terminal in which you entered the “tottag” command and simultaneously pressing CTRL+C. This should cause the application to forcefully terminate.
+
+The suggested procedure for setting up a pilot deployment is the following:
+
+1.	Determine exactly how many TotTags will be needed for the deployment, and choose this number of devices to set aside.
+2.	Make a note on a piece of scratch paper about which Device IDs should be associated with which user-friendly labels.
+3.	Open the TotTag Dashboard and go to the “Deployment” tab. Do not connect to any TotTags at this time.
+4.	Enter all relevant information about the upcoming deployment, including the mapping of TotTag labels to Device IDs.
+5.	Once all information has been entered, ensure that all relevant TotTags are discoverable in the device bar at the top of the dashboard.
+6.	Click the “Start” button to start the deployment programming process for all relevant devices.
+7.	Once complete, it is a good idea to individually connect to each of the participating devices and verify that both the current time and the experiment details are correct.
+
+After the above steps have been completed, your devices are ready for shipment and will automatically shut down until time for the deployment to begin. Upon completion of a pilot test, the first thing you should do upon receipt of the TotTags is to download all log files before putting the TotTags back into storage.

tottag-1.1.0/dashboard/1_convert_to_csv.py

@@ -0,0 +1,59 @@
+"""
+Function: This script finds all .pkl files in a specified directory, extracts the subject_id from the filename,
+loads the corresponding data, and processes it using the get_daily_ranging_statistics function.
+
+Usage:
+cd SociTrack/software/management/dashboard
+python3 1_tottags_batch.py
+"""
+
+import re
+import csv
+
+# Define input and output file paths
+input_file = "/Users/hannahpiersiak/Desktop/tottags/ranging_statistics.txt"
+output_file = "/Users/hannahpiersiak/Desktop/tottags/ranging_statistics.csv"
+
+# Open the input file and read its contents
+with open(input_file, "r") as file:
+    data = file.readlines()
+
+# Prepare data extraction
+csv_data = []
+current_date = None
+
+# Regex patterns to extract data
+date_pattern = re.compile(r"Ranging Statistics on (\d{2}/\d{2}/\d{4}):")
+stats_pattern = re.compile(r"Statistics to (r\.\d+_CG\d|Either of \[.*\]):")
+value_pattern = re.compile(r"^\s+(\w.+):\s+([\d.]+|nan)")
+
+# Parse the file line by line
+for line in data:
+    date_match = date_pattern.search(line)
+    stats_match = stats_pattern.search(line)
+    value_match = value_pattern.search(line)
+
+    if date_match:
+        current_date = date_match.group(1)  # Extract the date
+    elif stats_match:
+        current_target = stats_match.group(1)  # Extract the target (CG1, CG2, or Either)
+        minutes_range = minutes_touch = mean_distance = None
+    elif value_match:
+        key, value = value_match.groups()
+        if key == "Minutes in Range":
+            minutes_range = value
+        elif key == "Minutes in Touching Distance":
+            minutes_touch = value
+        elif key == "Mean Distance While in Range":
+            mean_distance = value
+            # Save row when all values for a section are collected
+            csv_data.append([current_date, current_target, minutes_range, minutes_touch, mean_distance])
+
+# Write to CSV file
+with open(output_file, "w", newline="") as file:
+    writer = csv.writer(file)
+    writer.writerow(["Date", "Target", "Minutes in Range", "Minutes in Touching Distance", "Mean Distance While in Range"])
+    writer.writerows(csv_data)
+
+print(f"CSV file saved: {output_file}")
+

tottag-1.1.0/dashboard/1_tottags_batch.py

@@ -0,0 +1,34 @@
+"""
+Function: This script finds all .pkl files in a specified directory, extracts the subject_id from the filename,
+loads the corresponding data, and processes it using the get_daily_ranging_statistics function.
+
+Usage:
+cd SociTrack/software/management/dashboard
+python3 1_tottags_batch.py
+"""
+
+import os
+from processing import *
+
+
+def process_pkl_files(directory):
+    """Find all .pkl files in the directory, extract subject_id, load data, and process it."""
+    for filename in os.listdir(directory):
+        if filename.endswith(".pkl"):
+            filepath = os.path.join(directory, filename)
+
+            # Extract subject_id from filename
+            subject_id = filename.split("_")[0]
+
+            # Load pkl data
+            TC = load_data(filepath)
+
+            # Call the function with formatted parameters
+            get_daily_ranging_statistics(TC, [f"{subject_id}_CG1", f"{subject_id}_CG2"], 3)
+
+
+# Define directory path
+directory_path = "/Users/hannahpiersiak/Desktop/tottags"
+
+# Run the function
+process_pkl_files(directory_path)

tottag-1.1.0/dashboard/2_convert_to_csv.py

@@ -0,0 +1,61 @@
+import csv
+import re
+
+# Input and output file paths
+input_file = "/Users/hannahpiersiak/Desktop/tottags/ranging_statistics.txt"
+output_file = "/Users/hannahpiersiak/Desktop/tottags/ranging_statistics.csv"
+
+# Regular expressions to extract relevant data
+date_pattern = re.compile(r"Ranging Statistics on (\d{2}/\d{2}/\d{4}):")
+entity_pattern = re.compile(r"Statistics to (\S+):")
+minutes_range_pattern = re.compile(r"Minutes in Range: (\d+)")
+minutes_touch_pattern = re.compile(r"Minutes in Touching Distance: (\d+)")
+mean_distance_pattern = re.compile(r"Mean Distance While in Range: (.+)")
+
+# Storage variables
+data = []
+current_date = None
+current_entity = None
+
+# Read and parse the text file
+with open(input_file, "r") as infile:
+    for line in infile:
+        line = line.strip()
+        
+        # Extract date
+        date_match = date_pattern.match(line)
+        if date_match:
+            current_date = date_match.group(1)
+            print(f"Date found: {current_date}")  # Debugging line
+            continue
+        
+        # Extract entity
+        entity_match = entity_pattern.match(line)
+        if entity_match:
+            current_entity = entity_match.group(1)
+            print(f"Entity found: {current_entity}")  # Debugging line
+            continue
+        
+        # Extract statistics
+        minutes_range_match = minutes_range_pattern.match(line)
+        minutes_touch_match = minutes_touch_pattern.match(line)
+        mean_distance_match = mean_distance_pattern.match(line)
+        
+        if minutes_range_match:
+            minutes_range = int(minutes_range_match.group(1))
+        if minutes_touch_match:
+            minutes_touch = int(minutes_touch_match.group(1))
+        if mean_distance_match:
+            mean_distance = mean_distance_match.group(1)  # Keep as string for 'nan' handling
+
+            # Save extracted data
+            print(f"Adding data: {current_date}, {current_entity}, {minutes_range}, {minutes_touch}, {mean_distance}")  # Debugging line
+            data.append([current_date, current_entity, minutes_range, minutes_touch, mean_distance])
+
+# Write to CSV
+with open(output_file, "w", newline="") as outfile:
+    writer = csv.writer(outfile)
+    writer.writerow(["Date", "Entity", "Minutes in Range", "Minutes in Touching Distance", "Mean Distance While in Range"])
+    writer.writerows(data)
+
+print(f"Data successfully written to {output_file}")

tottag-1.1.0/dashboard/2_tottags_batch.py

@@ -0,0 +1,34 @@
+"""
+Function: This script finds all .pkl files in a specified directory, extracts the subject_id from the filename,
+loads the corresponding data, and processes it using the get_daily_ranging_statistics function.
+
+Usage:
+cd SociTrack/software/management/dashboard
+python3 1_tottags_batch.py
+"""
+
+import os
+from processing import *
+
+
+def process_pkl_files(directory):
+    """Find all .pkl files in the directory, extract subject_id, load data, and process it."""
+    for filename in os.listdir(directory):
+        if filename.endswith(".pkl"):
+            filepath = os.path.join(directory, filename)
+
+            # Extract subject_id from filename
+            subject_id = filename.split("_")[0]
+
+            # Load pkl data
+            CG1 = load_data(filepath)
+
+            # Call the function with formatted parameters
+            get_daily_ranging_statistics(CG1, [f"{subject_id}_CG2"], 3)
+
+
+# Define directory path
+directory_path = "/Users/hannahpiersiak/Desktop/tottags"
+
+# Run the function
+process_pkl_files(directory_path)