accusleepy 0.3.1__py3-none-any.whl → 0.4.0__py3-none-any.whl

accusleepy/gui/main.py

@@ -5,6 +5,7 @@ import datetime
 import os
 import shutil
 import sys
+import toml
 from dataclasses import dataclass
 from functools import partial
 
@@ -54,7 +55,7 @@ from accusleepy.signal_processing import (
 MESSAGE_BOX_MAX_DEPTH = 50
 LABEL_LENGTH_ERROR = "label file length does not match recording length"
 # relative path to config guide txt file
-CONFIG_GUIDE_FILE = "text/config_guide.txt"
+CONFIG_GUIDE_FILE = os.path.normpath(r"text/config_guide.txt")
 
 
 @dataclass
@@ -116,6 +117,20 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
         # messages to display
         self.messages = []
 
+        # display current version
+        version = ""
+        toml_file = os.path.join(
+            os.path.dirname(
+                os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+            ),
+            "pyproject.toml",
+        )
+        if os.path.isfile(toml_file):
+            toml_data = toml.load(toml_file)
+            if "project" in toml_data and "version" in toml_data["project"]:
+                version = toml_data["project"]["version"]
+        self.ui.version_label.setText(f"v{version}")
+
         # user input: keyboard shortcuts
         keypress_quit = QtGui.QShortcut(
             QtGui.QKeySequence(
@@ -179,6 +194,7 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
         )
         if not filename:
             return
+        filename = os.path.normpath(filename)
         save_recording_list(filename=filename, recordings=self.recordings)
         self.show_message(f"Saved list of recordings to {filename}")
 
@@ -193,6 +209,7 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
         if file_dialog.exec():
             selected_files = file_dialog.selectedFiles()
             filename = selected_files[0]
+            filename = os.path.normpath(filename)
         else:
             return
 
@@ -229,7 +246,7 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
             if event.type() == QtCore.QEvent.Drop:
                 urls = event.mimeData().urls()
                 if len(urls) == 1:
-                    filename = urls[0].toLocalFile()
+                    filename = os.path.normpath(urls[0].toLocalFile())
 
         if filename is None:
             return super().eventFilter(obj, event)
@@ -289,6 +306,8 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
         )
         if not model_filename:
             self.show_message("Model training canceled, no filename given")
+            return
+        model_filename = os.path.normpath(model_filename)
 
         # create (probably temporary) image folder
         temp_image_dir = os.path.join(
@@ -363,6 +382,7 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
             self, "Select directory for training images"
         )
         if training_folder_parent:
+            training_folder_parent = os.path.normpath(training_folder_parent)
             self.training_image_dir = training_folder_parent
             self.ui.image_folder_label.setText(training_folder_parent)
 
@@ -560,6 +580,7 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
             if file_dialog.exec():
                 selected_files = file_dialog.selectedFiles()
                 filename = selected_files[0]
+                filename = os.path.normpath(filename)
             else:
                 return
 
@@ -707,6 +728,7 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
         )
         if not filename:
             return
+        filename = os.path.normpath(filename)
 
         create_calibration_file(
             filename=filename,
@@ -871,6 +893,7 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
             filter="*" + LABEL_FILE_TYPE,
         )
         if filename:
+            filename = os.path.normpath(filename)
             self.recordings[self.recording_index].label_file = filename
             self.ui.label_file_label.setText(filename)
 
@@ -885,6 +908,7 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
         if file_dialog.exec():
             selected_files = file_dialog.selectedFiles()
             filename = selected_files[0]
+            filename = os.path.normpath(filename)
             self.recordings[self.recording_index].label_file = filename
             self.ui.label_file_label.setText(filename)
 
@@ -899,6 +923,7 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
         if file_dialog.exec():
             selected_files = file_dialog.selectedFiles()
             filename = selected_files[0]
+            filename = os.path.normpath(filename)
             self.recordings[self.recording_index].calibration_file = filename
             self.ui.calibration_file_label.setText(filename)
 
@@ -913,6 +938,7 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
         if file_dialog.exec():
             selected_files = file_dialog.selectedFiles()
             filename = selected_files[0]
+            filename = os.path.normpath(filename)
             self.recordings[self.recording_index].recording_file = filename
             self.ui.recording_file_label.setText(filename)
 
@@ -1252,7 +1278,7 @@ def check_label_validity(
     sampling_rate: int | float,
     epoch_length: int | float,
     brain_state_set: BrainStateSet,
-) -> str:
+) -> str | None:
     """Check whether a set of brain state labels is valid
 
     This returns an error message if a problem is found with the
@@ -1352,6 +1378,7 @@ def check_config_consistency(
         output.append(
             (
                 "Warning: the epoch length used when training this model "
+                f"({model_epoch_length} seconds) "
                 "does not match the current epoch length setting."
             )
         )

accusleepy/gui/manual_scoring.py

@@ -27,7 +27,7 @@ LABEL_CMAP = np.concatenate(
     [np.array([[0, 0, 0, 0]]), plt.colormaps["tab10"](range(10))], axis=0
 )
 # relative path to user manual text file
-USER_MANUAL_FILE = "text/manual_scoring_guide.txt"
+USER_MANUAL_FILE = os.path.normpath(r"text/manual_scoring_guide.txt")
 
 # constants used by callback functions
 # label formats

accusleepy/gui/primary_window.py

@@ -8,20 +8,8 @@
 ## WARNING! All changes made in this file will be lost when recompiling UI file!
 ################################################################################
 
-from PySide6.QtCore import (
-    QCoreApplication,
-    QMetaObject,
-    QRect,
-    QSize,
-    Qt,
-)
-from PySide6.QtGui import (
-    QBrush,
-    QColor,
-    QFont,
-    QIcon,
-    QPalette,
-)
+from PySide6.QtCore import QCoreApplication, QMetaObject, QRect, QSize, Qt
+from PySide6.QtGui import QBrush, QColor, QFont, QIcon, QPalette
 from PySide6.QtWidgets import (
     QCheckBox,
     QDoubleSpinBox,
@@ -202,6 +190,8 @@ class Ui_PrimaryWindow(object):
 
         self.left_scoring_vlayout.addWidget(self.recordinglistgroupbox)
 
+        self.logo_and_version_layout = QVBoxLayout()
+        self.logo_and_version_layout.setObjectName("logo_and_version_layout")
         self.logo_layout = QVBoxLayout()
         self.logo_layout.setObjectName("logo_layout")
         self.frame = QFrame(self.scoring_tab)
@@ -252,7 +242,24 @@ class Ui_PrimaryWindow(object):
 
         self.logo_layout.addWidget(self.frame)
 
-        self.left_scoring_vlayout.addLayout(self.logo_layout)
+        self.logo_and_version_layout.addLayout(self.logo_layout)
+
+        self.version_label = QLabel(self.scoring_tab)
+        self.version_label.setObjectName("version_label")
+        sizePolicy3 = QSizePolicy(
+            QSizePolicy.Policy.Preferred, QSizePolicy.Policy.Fixed
+        )
+        sizePolicy3.setHorizontalStretch(0)
+        sizePolicy3.setVerticalStretch(0)
+        sizePolicy3.setHeightForWidth(
+            self.version_label.sizePolicy().hasHeightForWidth()
+        )
+        self.version_label.setSizePolicy(sizePolicy3)
+        self.version_label.setAlignment(Qt.AlignmentFlag.AlignCenter)
+
+        self.logo_and_version_layout.addWidget(self.version_label)
+
+        self.left_scoring_vlayout.addLayout(self.logo_and_version_layout)
 
         self.user_manual_layout = QHBoxLayout()
         self.user_manual_layout.setObjectName("user_manual_layout")
@@ -340,11 +347,6 @@ class Ui_PrimaryWindow(object):
         self.horizontalLayout.setObjectName("horizontalLayout")
         self.recording_file_button = QPushButton(self.selected_recording_groupbox)
         self.recording_file_button.setObjectName("recording_file_button")
-        sizePolicy3 = QSizePolicy(
-            QSizePolicy.Policy.Preferred, QSizePolicy.Policy.Fixed
-        )
-        sizePolicy3.setHorizontalStretch(0)
-        sizePolicy3.setVerticalStretch(0)
         sizePolicy3.setHeightForWidth(
             self.recording_file_button.sizePolicy().hasHeightForWidth()
         )
@@ -2217,9 +2219,23 @@ class Ui_PrimaryWindow(object):
         self.remove_button.setText(
             QCoreApplication.translate("PrimaryWindow", "remove", None)
         )
+        # if QT_CONFIG(tooltip)
+        self.export_button.setToolTip(
+            QCoreApplication.translate(
+                "PrimaryWindow", "Export recording list to file", None
+            )
+        )
+        # endif // QT_CONFIG(tooltip)
         self.export_button.setText(
             QCoreApplication.translate("PrimaryWindow", "export", None)
         )
+        # if QT_CONFIG(tooltip)
+        self.import_button.setToolTip(
+            QCoreApplication.translate(
+                "PrimaryWindow", "Import recording list from file", None
+            )
+        )
+        # endif // QT_CONFIG(tooltip)
         self.import_button.setText(
             QCoreApplication.translate("PrimaryWindow", "import", None)
         )
@@ -2232,6 +2248,9 @@ class Ui_PrimaryWindow(object):
         self.accusleepy1.setText(
             QCoreApplication.translate("PrimaryWindow", "AccuSleePy", None)
         )
+        self.version_label.setText(
+            QCoreApplication.translate("PrimaryWindow", "TextLabel", None)
+        )
         # if QT_CONFIG(tooltip)
         self.user_manual_button.setToolTip(
             QCoreApplication.translate("PrimaryWindow", "User manual", None)
@@ -2246,6 +2265,13 @@ class Ui_PrimaryWindow(object):
         self.samplingratelabel.setText(
             QCoreApplication.translate("PrimaryWindow", "Sampling rate (Hz):", None)
         )
+        # if QT_CONFIG(tooltip)
+        self.recording_file_button.setToolTip(
+            QCoreApplication.translate(
+                "PrimaryWindow", "Select EEG+EMG recording", None
+            )
+        )
+        # endif // QT_CONFIG(tooltip)
         self.recording_file_button.setText(
             QCoreApplication.translate("PrimaryWindow", "Select recording file", None)
         )
@@ -2288,10 +2314,24 @@ class Ui_PrimaryWindow(object):
             QCoreApplication.translate("PrimaryWindow", "Score manually", None)
         )
         self.manual_scoring_status.setText("")
+        # if QT_CONFIG(tooltip)
+        self.create_calibration_button.setToolTip(
+            QCoreApplication.translate(
+                "PrimaryWindow", "Create calibration file for this subject", None
+            )
+        )
+        # endif // QT_CONFIG(tooltip)
         self.create_calibration_button.setText(
             QCoreApplication.translate("PrimaryWindow", "Create calibration file", None)
         )
         self.calibration_status.setText("")
+        # if QT_CONFIG(tooltip)
+        self.select_calibration_button.setToolTip(
+            QCoreApplication.translate(
+                "PrimaryWindow", "Load calibration file for this recording", None
+            )
+        )
+        # endif // QT_CONFIG(tooltip)
         self.select_calibration_button.setText(
             QCoreApplication.translate("PrimaryWindow", "Select calibration file", None)
         )
@@ -2319,6 +2359,13 @@ class Ui_PrimaryWindow(object):
                 "PrimaryWindow", "Minimum bout length (sec):", None
             )
         )
+        # if QT_CONFIG(tooltip)
+        self.load_model_button.setToolTip(
+            QCoreApplication.translate(
+                "PrimaryWindow", "Load a trained sleep scoring classifier", None
+            )
+        )
+        # endif // QT_CONFIG(tooltip)
         self.load_model_button.setText(
             QCoreApplication.translate(
                 "PrimaryWindow", "Load classification model", None
@@ -2346,6 +2393,13 @@ class Ui_PrimaryWindow(object):
         self.real_time_button.setText(
             QCoreApplication.translate("PrimaryWindow", "Real-time", None)
         )
+        # if QT_CONFIG(tooltip)
+        self.train_model_button.setToolTip(
+            QCoreApplication.translate(
+                "PrimaryWindow", "Begin training the classification model", None
+            )
+        )
+        # endif // QT_CONFIG(tooltip)
         self.train_model_button.setText(
             QCoreApplication.translate(
                 "PrimaryWindow", "Train classification model", None
@@ -2422,6 +2476,13 @@ class Ui_PrimaryWindow(object):
         self.label_17.setText(
             QCoreApplication.translate("PrimaryWindow", "Default epoch length:", None)
         )
+        # if QT_CONFIG(tooltip)
+        self.save_config_button.setToolTip(
+            QCoreApplication.translate(
+                "PrimaryWindow", "Save current configuration", None
+            )
+        )
+        # endif // QT_CONFIG(tooltip)
         self.save_config_button.setText(
             QCoreApplication.translate("PrimaryWindow", "Save", None)
         )

accusleepy/gui/primary_window.ui

@@ -263,6 +263,9 @@
                      <verstretch>0</verstretch>
                     </sizepolicy>
                    </property>
+                   <property name="toolTip">
+                    <string>Export recording list to file</string>
+                   </property>
                    <property name="text">
                     <string>export</string>
                    </property>
@@ -276,6 +279,9 @@
                      <verstretch>0</verstretch>
                     </sizepolicy>
                    </property>
+                   <property name="toolTip">
+                    <string>Import recording list from file</string>
+                   </property>
                    <property name="text">
                     <string>import</string>
                    </property>
@@ -287,132 +293,152 @@
              </widget>
             </item>
             <item>
-             <layout class="QVBoxLayout" name="logo_layout">
+             <layout class="QVBoxLayout" name="logo_and_version_layout">
+              <item>
+               <layout class="QVBoxLayout" name="logo_layout">
+                <item>
+                 <widget class="QFrame" name="frame">
+                  <property name="sizePolicy">
+                   <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
+                    <horstretch>0</horstretch>
+                    <verstretch>0</verstretch>
+                   </sizepolicy>
+                  </property>
+                  <property name="minimumSize">
+                   <size>
+                    <width>180</width>
+                    <height>80</height>
+                   </size>
+                  </property>
+                  <property name="styleSheet">
+                   <string notr="true">background-color: transparent;</string>
+                  </property>
+                  <property name="frameShape">
+                   <enum>QFrame::Shape::NoFrame</enum>
+                  </property>
+                  <property name="frameShadow">
+                   <enum>QFrame::Shadow::Raised</enum>
+                  </property>
+                  <widget class="QLabel" name="accusleepy2">
+                   <property name="geometry">
+                    <rect>
+                     <x>11</x>
+                     <y>15</y>
+                     <width>160</width>
+                     <height>50</height>
+                    </rect>
+                   </property>
+                   <property name="sizePolicy">
+                    <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
+                     <horstretch>0</horstretch>
+                     <verstretch>0</verstretch>
+                    </sizepolicy>
+                   </property>
+                   <property name="font">
+                    <font>
+                     <pointsize>21</pointsize>
+                     <italic>true</italic>
+                     <bold>true</bold>
+                    </font>
+                   </property>
+                   <property name="styleSheet">
+                    <string notr="true">background-color: transparent;
+color: rgb(130, 169, 68);</string>
+                   </property>
+                   <property name="text">
+                    <string>AccuSleePy</string>
+                   </property>
+                   <property name="alignment">
+                    <set>Qt::AlignmentFlag::AlignCenter</set>
+                   </property>
+                  </widget>
+                  <widget class="QLabel" name="accusleepy3">
+                   <property name="geometry">
+                    <rect>
+                     <x>13</x>
+                     <y>17</y>
+                     <width>160</width>
+                     <height>50</height>
+                    </rect>
+                   </property>
+                   <property name="sizePolicy">
+                    <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
+                     <horstretch>0</horstretch>
+                     <verstretch>0</verstretch>
+                    </sizepolicy>
+                   </property>
+                   <property name="font">
+                    <font>
+                     <pointsize>21</pointsize>
+                     <italic>true</italic>
+                     <bold>true</bold>
+                    </font>
+                   </property>
+                   <property name="styleSheet">
+                    <string notr="true">background-color: transparent;
+color: rgb(46, 63, 150);</string>
+                   </property>
+                   <property name="text">
+                    <string>AccuSleePy</string>
+                   </property>
+                   <property name="alignment">
+                    <set>Qt::AlignmentFlag::AlignCenter</set>
+                   </property>
+                  </widget>
+                  <widget class="QLabel" name="accusleepy1">
+                   <property name="geometry">
+                    <rect>
+                     <x>9</x>
+                     <y>13</y>
+                     <width>160</width>
+                     <height>50</height>
+                    </rect>
+                   </property>
+                   <property name="sizePolicy">
+                    <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
+                     <horstretch>0</horstretch>
+                     <verstretch>0</verstretch>
+                    </sizepolicy>
+                   </property>
+                   <property name="font">
+                    <font>
+                     <pointsize>21</pointsize>
+                     <italic>true</italic>
+                     <bold>true</bold>
+                    </font>
+                   </property>
+                   <property name="styleSheet">
+                    <string notr="true">background-color: transparent;
+color: rgb(244, 195, 68);</string>
+                   </property>
+                   <property name="text">
+                    <string>AccuSleePy</string>
+                   </property>
+                   <property name="alignment">
+                    <set>Qt::AlignmentFlag::AlignCenter</set>
+                   </property>
+                  </widget>
+                  <zorder>accusleepy1</zorder>
+                  <zorder>accusleepy2</zorder>
+                  <zorder>accusleepy3</zorder>
+                 </widget>
+                </item>
+               </layout>
+              </item>
               <item>
-               <widget class="QFrame" name="frame">
+               <widget class="QLabel" name="version_label">
                 <property name="sizePolicy">
-                 <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
+                 <sizepolicy hsizetype="Preferred" vsizetype="Fixed">
                   <horstretch>0</horstretch>
                   <verstretch>0</verstretch>
                  </sizepolicy>
                 </property>
-                <property name="minimumSize">
-                 <size>
-                  <width>180</width>
-                  <height>80</height>
-                 </size>
-                </property>
-                <property name="styleSheet">
-                 <string notr="true">background-color: transparent;</string>
-                </property>
-                <property name="frameShape">
-                 <enum>QFrame::Shape::NoFrame</enum>
+                <property name="text">
+                 <string>TextLabel</string>
                 </property>
-                <property name="frameShadow">
-                 <enum>QFrame::Shadow::Raised</enum>
+                <property name="alignment">
+                 <set>Qt::AlignmentFlag::AlignCenter</set>
                 </property>
-                <widget class="QLabel" name="accusleepy2">
-                 <property name="geometry">
-                  <rect>
-                   <x>11</x>
-                   <y>15</y>
-                   <width>160</width>
-                   <height>50</height>
-                  </rect>
-                 </property>
-                 <property name="sizePolicy">
-                  <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
-                   <horstretch>0</horstretch>
-                   <verstretch>0</verstretch>
-                  </sizepolicy>
-                 </property>
-                 <property name="font">
-                  <font>
-                   <pointsize>21</pointsize>
-                   <italic>true</italic>
-                   <bold>true</bold>
-                  </font>
-                 </property>
-                 <property name="styleSheet">
-                  <string notr="true">background-color: transparent;
-color: rgb(130, 169, 68);</string>
-                 </property>
-                 <property name="text">
-                  <string>AccuSleePy</string>
-                 </property>
-                 <property name="alignment">
-                  <set>Qt::AlignmentFlag::AlignCenter</set>
-                 </property>
-                </widget>
-                <widget class="QLabel" name="accusleepy3">
-                 <property name="geometry">
-                  <rect>
-                   <x>13</x>
-                   <y>17</y>
-                   <width>160</width>
-                   <height>50</height>
-                  </rect>
-                 </property>
-                 <property name="sizePolicy">
-                  <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
-                   <horstretch>0</horstretch>
-                   <verstretch>0</verstretch>
-                  </sizepolicy>
-                 </property>
-                 <property name="font">
-                  <font>
-                   <pointsize>21</pointsize>
-                   <italic>true</italic>
-                   <bold>true</bold>
-                  </font>
-                 </property>
-                 <property name="styleSheet">
-                  <string notr="true">background-color: transparent;
-color: rgb(46, 63, 150);</string>
-                 </property>
-                 <property name="text">
-                  <string>AccuSleePy</string>
-                 </property>
-                 <property name="alignment">
-                  <set>Qt::AlignmentFlag::AlignCenter</set>
-                 </property>
-                </widget>
-                <widget class="QLabel" name="accusleepy1">
-                 <property name="geometry">
-                  <rect>
-                   <x>9</x>
-                   <y>13</y>
-                   <width>160</width>
-                   <height>50</height>
-                  </rect>
-                 </property>
-                 <property name="sizePolicy">
-                  <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
-                   <horstretch>0</horstretch>
-                   <verstretch>0</verstretch>
-                  </sizepolicy>
-                 </property>
-                 <property name="font">
-                  <font>
-                   <pointsize>21</pointsize>
-                   <italic>true</italic>
-                   <bold>true</bold>
-                  </font>
-                 </property>
-                 <property name="styleSheet">
-                  <string notr="true">background-color: transparent;
-color: rgb(244, 195, 68);</string>
-                 </property>
-                 <property name="text">
-                  <string>AccuSleePy</string>
-                 </property>
-                 <property name="alignment">
-                  <set>Qt::AlignmentFlag::AlignCenter</set>
-                 </property>
-                </widget>
-                <zorder>accusleepy1</zorder>
-                <zorder>accusleepy2</zorder>
-                <zorder>accusleepy3</zorder>
                </widget>
               </item>
              </layout>
@@ -562,6 +588,9 @@ color: rgb(244, 195, 68);</string>
                          <verstretch>0</verstretch>
                         </sizepolicy>
                        </property>
+                       <property name="toolTip">
+                        <string>Select EEG+EMG recording</string>
+                       </property>
                        <property name="text">
                         <string>Select recording file</string>
                        </property>
@@ -753,6 +782,9 @@ color: rgb(244, 195, 68);</string>
                        <verstretch>0</verstretch>
                       </sizepolicy>
                      </property>
+                     <property name="toolTip">
+                      <string>Create calibration file for this subject</string>
+                     </property>
                      <property name="text">
                       <string>Create calibration file</string>
                      </property>
@@ -813,6 +845,9 @@ color: rgb(244, 195, 68);</string>
                          <verstretch>0</verstretch>
                         </sizepolicy>
                        </property>
+                       <property name="toolTip">
+                        <string>Load calibration file for this recording</string>
+                       </property>
                        <property name="text">
                         <string>Select calibration file</string>
                        </property>
@@ -1042,6 +1077,9 @@ color: rgb(244, 195, 68);</string>
                             <verstretch>0</verstretch>
                            </sizepolicy>
                           </property>
+                          <property name="toolTip">
+                           <string>Load a trained sleep scoring classifier</string>
+                          </property>
                           <property name="text">
                            <string>Load classification model</string>
                           </property>
@@ -1296,6 +1334,9 @@ color: rgb(244, 195, 68);</string>
                           <verstretch>0</verstretch>
                          </sizepolicy>
                         </property>
+                        <property name="toolTip">
+                         <string>Begin training the classification model</string>
+                        </property>
                         <property name="text">
                          <string>Train classification model</string>
                         </property>
@@ -3553,6 +3594,9 @@ color: rgb(244, 195, 68);</string>
                   <verstretch>0</verstretch>
                  </sizepolicy>
                 </property>
+                <property name="toolTip">
+                 <string>Save current configuration</string>
+                </property>
                 <property name="text">
                  <string>Save</string>
                 </property>

accusleepy/gui/text/config_guide.txt

@@ -1,5 +1,4 @@
 This is the current brain state configuration.
-You can also choose the default epoch length.
 If you make changes, click 'Save' to store them.
 
 Each brain state has several attributes:
@@ -26,3 +25,5 @@ Important notes:
 - Changing these settings can invalidate existing label files,
     calibration files, and trained models!
 - Reinstalling AccuSleePy will overwrite this configuration.
+- You can also choose the default epoch length that is shown
+    when the primary interface starts up.

accusleepy/gui/text/main_guide_text.py

@@ -1,11 +1,31 @@
-from accusleepy.constants import BRAIN_STATE_COL, EEG_COL, EMG_COL, UNDEFINED_LABEL
+from accusleepy.constants import (
+    BRAIN_STATE_COL,
+    CALIBRATION_FILE_TYPE,
+    EEG_COL,
+    EMG_COL,
+    LABEL_FILE_TYPE,
+    MODEL_FILE_TYPE,
+    RECORDING_FILE_TYPES,
+    UNDEFINED_LABEL,
+)
 
 MAIN_GUIDE_TEXT = f"""
+Section 0: Definitions
 Section 1: Overview of the GUI
 Section 2: AccuSleePy file types
 Section 3: Manually assigning brain state labels
 Section 4: Automatically assigning brain state labels
 
+-----------------------------------------------------------------------
+Section 0: Definitions
+-----------------------------------------------------------------------
+Recording: a table containing one channel of EEG data and one channel
+    of EMG data collected at a constant sampling rate.
+Epoch: the temporal resolution of brain state scoring. If, for example,
+    the epoch length is 5 seconds, then a brain state label will be
+    assigned to each 5-second segment of a recording.
+Bout: a contiguous set of epochs with the same brain state.
+
 -----------------------------------------------------------------------
 Section 1: Overview of the primary interface
 -----------------------------------------------------------------------
@@ -43,17 +63,17 @@ There are four types of files associated with AccuSleePy.
 To select a file in the primary interface, you can either use the
 associated button, or drag/drop the file into the empty box adjacent
 to the button.
-Recording file: a .csv or .parquet file containing one column of EEG
-    data and one column of EMG data. The column names must be
-    {EEG_COL} and {EMG_COL}.
-Label file: a .csv file with one column titled {BRAIN_STATE_COL}
-    with entries that are either the undefined brain state, {UNDEFINED_LABEL},
+Recording file: a {" or ".join(RECORDING_FILE_TYPES)} file containing one
+    column of EEG  data and one column of EMG data.
+    The column names must be {EEG_COL} and {EMG_COL}.
+Label file: a {LABEL_FILE_TYPE} file with one column titled {BRAIN_STATE_COL}
+    with entries that are either the undefined brain state ({UNDEFINED_LABEL})
     or one of the digits in your brain state configuration.
     By default, these are 1-3 where REM = 1, wake = 2, NREM = 3.
 Calibration data file: required for automatic labeling. See Section 4
-    for details. These have .csv format.
+    for details. These have {CALIBRATION_FILE_TYPE} format.
 Trained classification model: required for automatic labeling. See
-    Section 4 for details. These have .pth format.
+    Section 4 for details. These have {MODEL_FILE_TYPE} format.
 
 -----------------------------------------------------------------------
 Section 3: Manually assigning brain state labels
@@ -103,6 +123,10 @@ To create a calibration data file:
 4. Enter a filename for the calibration data file.
 5. The calibration file will automatically be assigned to the currently
     selected recording.
+Note that epoch length can affect the calibration process. If you make
+a calibration file for a subject using one epoch length, but want to
+score another recording from the same subject with a different epoch
+length, it's best to create a new calibration file.
 
 --- Section 4B: Training your own classification model ---
 To train a new model on your own data:

{accusleepy-0.3.1.dist-info → accusleepy-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: accusleepy
-Version: 0.3.1
+Version: 0.4.0
 Summary: Python implementation of AccuSleep
 License: GPL-3.0-only
 Author: Zeke Barger
@@ -20,6 +20,7 @@ Requires-Dist: pillow (>=11.1.0,<12.0.0)
 Requires-Dist: pre-commit (>=4.2.0,<5.0.0)
 Requires-Dist: pyside6 (>=6.7.1,<6.8.0)
 Requires-Dist: scipy (>=1.15.2,<2.0.0)
+Requires-Dist: toml (>=0.10.2,<0.11.0)
 Requires-Dist: torch (>=2.6.0,<3.0.0)
 Requires-Dist: torchvision (>=0.21.0,<0.22.0)
 Requires-Dist: tqdm (>=4.67.1,<5.0.0)

{accusleepy-0.3.1.dist-info → accusleepy-0.4.0.dist-info}/RECORD

@@ -17,21 +17,21 @@ accusleepy/gui/icons/save.png,sha256=J3EA8iU1BqLYRSsrq_OdoZlqrv2yfL7oV54DklTy_DI
 accusleepy/gui/icons/up_arrow.png,sha256=V9yF9t1WgjPaUu-mF1YGe_DfaRHg2dUpR_sUVVcvVvY,3329
 accusleepy/gui/icons/zoom_in.png,sha256=MFWnKZp7Rvh4bLPq4Cqo4sB_jQYedUUtT8-ZO8tNYyc,13589
 accusleepy/gui/icons/zoom_out.png,sha256=IB8Jecb3i0U4qjWRR46ridjLpvLCSe7PozBaLqQqYSw,13055
-accusleepy/gui/main.py,sha256=IGhSD9vSTO09H72Ou1icbujQfzCy1twTCdeR2Dv8I7s,53055
-accusleepy/gui/manual_scoring.py,sha256=Jfu7uxXk6W4mmq81h4LnLSArP735l0XvbuZq9yYG650,40686
+accusleepy/gui/main.py,sha256=r6NWxwWkkkOOeXDfKggrGA6d8d3RS0M4Ylf2HhtnoPk,54234
+accusleepy/gui/manual_scoring.py,sha256=RaOpFso9whXib3MfiZblGJoTS-_dehBnSA-rtvO0qBo,40705
 accusleepy/gui/mplwidget.py,sha256=f9O3u_96whQGUwpi3o_QGc7yjiETX5vE0oj3ePXTJWE,12279
-accusleepy/gui/primary_window.py,sha256=eK9yrU6PK5hX1RORjc7DvqCDuDt55iA1LylXp3oh0j8,101850
-accusleepy/gui/primary_window.ui,sha256=NqCSnvlC1mKrWNn034u8avpMF7WudlR8G5jLjFNdTmk,144812
+accusleepy/gui/primary_window.py,sha256=RXpDvcb7zy8Ea4Da1VhMG1T6GC54KW3vyGjqqQJN45k,104582
+accusleepy/gui/primary_window.ui,sha256=09k4xFcjgOL9mlhFlg6mXCc_tgj4_FY9CZ3H03e3z3A,147074
 accusleepy/gui/resources.qrc,sha256=ByNEmJqr0YbKBqoZGvONZtjyNYr4ST4enO6TEdYSqWg,802
 accusleepy/gui/resources_rc.py,sha256=Z2e34h30U4snJjnYdZVV9B6yjATKxxfvgTRt5uXtQdo,329727
-accusleepy/gui/text/config_guide.txt,sha256=wz2QtRgd1eXUZMmtfAIVgqvDOtjkOnTOK-IGkLALg4U,1073
-accusleepy/gui/text/main_guide_text.py,sha256=YP-2sexvU5VIeKc1FXHsG0cUCgGfcU4qLD59JRlOMMo,8038
+accusleepy/gui/text/config_guide.txt,sha256=7xyo5ifQjWgXmCdgHuei0DCsXZcU4vo5VRlpOb2KVs4,1130
+accusleepy/gui/text/main_guide_text.py,sha256=4WpPYpuXCX811roitKuEI68dWIBNFrNrMyiKO2u8xyY,9050
 accusleepy/gui/text/manual_scoring_guide.txt,sha256=onBnUZJyX18oN1CgjD2HSnlEQHsUscHpOYf11kTKZ4U,1460
 accusleepy/gui/viewer_window.py,sha256=5PkbuYMXUegH1CExCoqSGDZ9GeJqCCUz0-3WWkM8Vfc,24049
 accusleepy/gui/viewer_window.ui,sha256=D1LwUFR-kZ_GWGZFFtXvGJdFWghLrOWZTblQeLQt9kI,30525
 accusleepy/models.py,sha256=Muapsw088AUHqRIbW97Rkbv0oiwCtQvO9tEoBCC-MYg,1476
 accusleepy/multitaper.py,sha256=V6MJDk0OSWhg2MFhrnt9dvYrHiNsk2T7IxAA7paZVyE,25549
 accusleepy/signal_processing.py,sha256=-aXnywfp1LBsk3DcbIMmZlgv3f8j6sZ6js0bizZId0o,21718
-accusleepy-0.3.1.dist-info/METADATA,sha256=xgwUR8pWzqQp3fi_g6UXCVbvxrL3CdVahoq476bIEaQ,2729
-accusleepy-0.3.1.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-accusleepy-0.3.1.dist-info/RECORD,,
+accusleepy-0.4.0.dist-info/METADATA,sha256=QRIDk41bldqfRDcdCoQCVnVk4GkcwHSpV1cQm8dmRdI,2768
+accusleepy-0.4.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+accusleepy-0.4.0.dist-info/RECORD,,