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

accusleepy/config.json

@@ -18,5 +18,6 @@
             "is_scored": true,
             "frequency": 0.55
         }
-    ]
-}
+    ],
+    "default_epoch_length": 2.5
+}

accusleepy/constants.py

@@ -35,3 +35,5 @@ LABEL_COL = "label"
 # recording list file header:
 RECORDING_LIST_NAME = "recording_list"
 RECORDING_LIST_FILE_TYPE = ".json"
+# key for default epoch length in config
+DEFAULT_EPOCH_LENGTH_KEY = "default_epoch_length"

accusleepy/fileio.py

@@ -11,6 +11,7 @@ from accusleepy.brain_state_set import BRAIN_STATES_KEY, BrainState, BrainStateS
 from accusleepy.constants import (
     BRAIN_STATE_COL,
     CONFIG_FILE,
+    DEFAULT_EPOCH_LENGTH_KEY,
     EEG_COL,
     EMG_COL,
     MIXTURE_MEAN_COL,
@@ -82,7 +83,9 @@ def load_model(filename: str) -> tuple[SSANN, int | float, int, str, dict]:
         (default or real-time), set of brain state options
         used when training the model
     """
-    state_dict = torch.load(filename, weights_only=True)
+    state_dict = torch.load(
+        filename, weights_only=True, map_location=torch.device("cpu")
+    )
     epoch_length = state_dict.pop("epoch_length")
     epochs_per_img = state_dict.pop("epochs_per_img")
     model_type = state_dict.pop("model_type")
@@ -141,10 +144,10 @@ def save_labels(labels: np.array, filename: str) -> None:
     pd.DataFrame({BRAIN_STATE_COL: labels}).to_csv(filename, index=False)
 
 
-def load_config() -> BrainStateSet:
+def load_config() -> tuple[BrainStateSet, int | float]:
     """Load configuration file with brain state options
 
-    :return: set of brain state options
+    :return: set of brain state options and default epoch length
     """
     with open(
         os.path.join(os.path.dirname(os.path.abspath(__file__)), CONFIG_FILE), "r"
@@ -152,18 +155,23 @@ def load_config() -> BrainStateSet:
         data = json.load(f)
     return BrainStateSet(
         [BrainState(**b) for b in data[BRAIN_STATES_KEY]], UNDEFINED_LABEL
-    )
+    ), data[DEFAULT_EPOCH_LENGTH_KEY]
 
 
-def save_config(brain_state_set: BrainStateSet) -> None:
+def save_config(
+    brain_state_set: BrainStateSet, default_epoch_length: int | float
+) -> None:
     """Save configuration of brain state options to json file
 
     :param brain_state_set: set of brain state options
+    :param default_epoch_length: epoch length to use when the GUI starts
     """
+    output_dict = brain_state_set.to_output_dict()
+    output_dict.update({DEFAULT_EPOCH_LENGTH_KEY: default_epoch_length})
     with open(
         os.path.join(os.path.dirname(os.path.abspath(__file__)), CONFIG_FILE), "w"
     ) as f:
-        json.dump(brain_state_set.to_output_dict(), f, indent=4)
+        json.dump(output_dict, f, indent=4)
 
 
 def load_recording_list(filename: str) -> list[Recording]:

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
 
@@ -40,6 +41,7 @@ from accusleepy.fileio import (
     save_model,
     save_recording_list,
 )
+from accusleepy.gui.text.main_guide_text import MAIN_GUIDE_TEXT
 from accusleepy.gui.manual_scoring import ManualScoringWindow
 from accusleepy.gui.primary_window import Ui_PrimaryWindow
 from accusleepy.signal_processing import (
@@ -52,9 +54,8 @@ from accusleepy.signal_processing import (
 # max number of messages to display
 MESSAGE_BOX_MAX_DEPTH = 50
 LABEL_LENGTH_ERROR = "label file length does not match recording length"
-# relative path to user manual txt file
-USER_MANUAL_FILE = "text/main_guide.txt"
-CONFIG_GUIDE_FILE = "text/config_guide.txt"
+# relative path to config guide txt file
+CONFIG_GUIDE_FILE = os.path.normpath(r"text/config_guide.txt")
 
 
 @dataclass
@@ -80,12 +81,12 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
         self.setWindowTitle("AccuSleePy")
 
         # fill in settings tab
-        self.brain_state_set = load_config()
+        self.brain_state_set, self.epoch_length = load_config()
         self.settings_widgets = None
         self.initialize_settings_tab()
 
         # initialize info about the recordings, classification data / settings
-        self.epoch_length = 0
+        self.ui.epoch_length_input.setValue(self.epoch_length)
         self.model = None
         self.only_overwrite_undefined = False
         self.min_bout_length = 5
@@ -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,24 +306,31 @@ 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(
+            self.training_image_dir,
+            "images_" + datetime.datetime.now().strftime("%Y%m%d%H%M"),
+        )
 
-        # create image folder
-        if os.path.exists(self.training_image_dir):
+        if os.path.exists(temp_image_dir):  # unlikely
             self.show_message(
                 "Warning: training image folder exists, will be overwritten"
             )
-        os.makedirs(self.training_image_dir, exist_ok=True)
+        os.makedirs(temp_image_dir, exist_ok=True)
 
         # create training images
         self.show_message(
-            (f"Creating training images in {self.training_image_dir}, please wait...")
+            (f"Creating training images in {temp_image_dir}, please wait...")
         )
         self.ui.message_area.repaint()
         QtWidgets.QApplication.processEvents()
         print("Creating training images")
         failed_recordings = create_training_images(
             recordings=self.recordings,
-            output_path=self.training_image_dir,
+            output_path=temp_image_dir,
             epoch_length=self.epoch_length,
             epochs_per_img=self.training_epochs_per_img,
             brain_state_set=self.brain_state_set,
@@ -330,10 +354,8 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
         QtWidgets.QApplication.processEvents()
         print("Training model")
         model = train_model(
-            annotations_file=os.path.join(
-                self.training_image_dir, ANNOTATIONS_FILENAME
-            ),
-            img_dir=self.training_image_dir,
+            annotations_file=os.path.join(temp_image_dir, ANNOTATIONS_FILENAME),
+            img_dir=temp_image_dir,
             mixture_weights=self.brain_state_set.mixture_weights,
             n_classes=self.brain_state_set.n_classes,
         )
@@ -350,20 +372,19 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
 
         # optionally delete images
         if self.delete_training_images:
-            shutil.rmtree(self.training_image_dir)
+            shutil.rmtree(temp_image_dir)
 
         self.show_message(f"Training complete, saved model to {model_filename}")
 
-    def set_training_folder(self):
+    def set_training_folder(self) -> None:
+        """Select location in which to create a folder for training images"""
         training_folder_parent = QtWidgets.QFileDialog.getExistingDirectory(
             self, "Select directory for training images"
         )
         if training_folder_parent:
-            self.training_image_dir = os.path.join(
-                training_folder_parent,
-                "images_" + datetime.datetime.now().strftime("%Y%m%d%H%M"),
-            )
-            self.ui.image_folder_label.setText(self.training_image_dir)
+            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)
 
     def update_image_deletion(self) -> None:
         """Update choice of whether to delete images after training"""
@@ -559,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
 
@@ -706,6 +728,7 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
         )
         if not filename:
             return
+        filename = os.path.normpath(filename)
 
         create_calibration_file(
             filename=filename,
@@ -870,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)
 
@@ -884,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)
 
@@ -898,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)
 
@@ -912,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)
 
@@ -1004,15 +1031,8 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
 
     def show_user_manual(self) -> None:
         """Show a popup window with the user manual"""
-        user_manual_file = open(
-            os.path.join(os.path.dirname(os.path.abspath(__file__)), USER_MANUAL_FILE),
-            "r",
-        )
-        user_manual_text = user_manual_file.read()
-        user_manual_file.close()
-
         label_widget = QtWidgets.QLabel()
-        label_widget.setText(user_manual_text)
+        label_widget.setText(MAIN_GUIDE_TEXT)
         scroll_area = QtWidgets.QScrollArea()
         scroll_area.setStyleSheet("background-color: white;")
         scroll_area.setWidget(label_widget)
@@ -1110,6 +1130,7 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
         }
 
         # update widget state to display current config
+        self.ui.default_epoch_input.setValue(self.epoch_length)
         states = {b.digit: b for b in self.brain_state_set.brain_states}
         for digit in range(10):
             if digit in states.keys():
@@ -1247,7 +1268,7 @@ class AccuSleepWindow(QtWidgets.QMainWindow):
         self.brain_state_set = BrainStateSet(brain_states, UNDEFINED_LABEL)
 
         # save to file
-        save_config(self.brain_state_set)
+        save_config(self.brain_state_set, self.ui.default_epoch_input.value())
         self.ui.save_config_status.setText("configuration saved")
 
 
@@ -1257,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
@@ -1357,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
@@ -111,7 +111,7 @@ class ManualScoringWindow(QtWidgets.QDialog):
         self.setWindowTitle("AccuSleePy manual scoring window")
 
         # load set of valid brain states
-        self.brain_state_set = load_config()
+        self.brain_state_set, _ = load_config()
 
         # initial setting for number of epochs to show in the lower plot
         self.epochs_to_show = 5
@@ -833,7 +833,7 @@ class ManualScoringWindow(QtWidgets.QDialog):
             self.adjust_upper_figure_x_limits()
 
         # update parts of lower plot
-        old_window_center = round(self.epochs_to_show / 2) + self.lower_left_epoch
+        old_window_center = round((self.epochs_to_show - 1) / 2) + self.lower_left_epoch
         # change the window bounds if needed
         if self.epoch < old_window_center and self.lower_left_epoch > 0:
             self.lower_left_epoch -= 1

accusleepy/gui/primary_window.py

@@ -100,6 +100,11 @@ class Ui_PrimaryWindow(object):
             self.epoch_length_input.sizePolicy().hasHeightForWidth()
         )
         self.epoch_length_input.setSizePolicy(sizePolicy1)
+        self.epoch_length_input.setAlignment(
+            Qt.AlignmentFlag.AlignLeading
+            | Qt.AlignmentFlag.AlignLeft
+            | Qt.AlignmentFlag.AlignVCenter
+        )
         self.epoch_length_input.setMaximum(100000.000000000000000)
         self.epoch_length_input.setSingleStep(0.500000000000000)
 
@@ -185,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)
@@ -235,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")
@@ -293,6 +317,11 @@ class Ui_PrimaryWindow(object):
             self.sampling_rate_input.sizePolicy().hasHeightForWidth()
         )
         self.sampling_rate_input.setSizePolicy(sizePolicy1)
+        self.sampling_rate_input.setAlignment(
+            Qt.AlignmentFlag.AlignLeading
+            | Qt.AlignmentFlag.AlignLeft
+            | Qt.AlignmentFlag.AlignVCenter
+        )
         self.sampling_rate_input.setMinimum(0.000000000000000)
         self.sampling_rate_input.setMaximum(100000.000000000000000)
 
@@ -318,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()
         )
@@ -608,6 +632,11 @@ class Ui_PrimaryWindow(object):
             self.bout_length_input.sizePolicy().hasHeightForWidth()
         )
         self.bout_length_input.setSizePolicy(sizePolicy1)
+        self.bout_length_input.setAlignment(
+            Qt.AlignmentFlag.AlignLeading
+            | Qt.AlignmentFlag.AlignLeft
+            | Qt.AlignmentFlag.AlignVCenter
+        )
         self.bout_length_input.setDecimals(2)
         self.bout_length_input.setMaximum(1000.000000000000000)
         self.bout_length_input.setValue(5.000000000000000)
@@ -2044,6 +2073,44 @@ class Ui_PrimaryWindow(object):
 
         self.verticalLayout_6.addLayout(self.horizontalLayout_4)
 
+        self.default_epoch_layout = QHBoxLayout()
+        self.default_epoch_layout.setObjectName("default_epoch_layout")
+        self.horizontalSpacer_71 = QSpacerItem(
+            10, 10, QSizePolicy.Policy.Preferred, QSizePolicy.Policy.Minimum
+        )
+
+        self.default_epoch_layout.addItem(self.horizontalSpacer_71)
+
+        self.horizontalLayout_60 = QHBoxLayout()
+        self.horizontalLayout_60.setObjectName("horizontalLayout_60")
+        self.label_17 = QLabel(self.settings_tab)
+        self.label_17.setObjectName("label_17")
+        sizePolicy1.setHeightForWidth(self.label_17.sizePolicy().hasHeightForWidth())
+        self.label_17.setSizePolicy(sizePolicy1)
+
+        self.horizontalLayout_60.addWidget(self.label_17)
+
+        self.default_epoch_input = QDoubleSpinBox(self.settings_tab)
+        self.default_epoch_input.setObjectName("default_epoch_input")
+        sizePolicy1.setHeightForWidth(
+            self.default_epoch_input.sizePolicy().hasHeightForWidth()
+        )
+        self.default_epoch_input.setSizePolicy(sizePolicy1)
+        self.default_epoch_input.setMaximum(100000.000000000000000)
+        self.default_epoch_input.setSingleStep(0.500000000000000)
+
+        self.horizontalLayout_60.addWidget(self.default_epoch_input)
+
+        self.default_epoch_layout.addLayout(self.horizontalLayout_60)
+
+        self.horizontalSpacer_70 = QSpacerItem(
+            10, 10, QSizePolicy.Policy.Preferred, QSizePolicy.Policy.Minimum
+        )
+
+        self.default_epoch_layout.addItem(self.horizontalSpacer_70)
+
+        self.verticalLayout_6.addLayout(self.default_epoch_layout)
+
         self.horizontalLayout_18 = QHBoxLayout()
         self.horizontalLayout_18.setSpacing(10)
         self.horizontalLayout_18.setObjectName("horizontalLayout_18")
@@ -2079,6 +2146,7 @@ class Ui_PrimaryWindow(object):
         self.verticalLayout_6.addLayout(self.horizontalLayout_18)
 
         self.verticalLayout_6.setStretch(0, 2)
+        self.verticalLayout_6.setStretch(1, 2)
         self.verticalLayout_6.setStretch(2, 2)
         self.verticalLayout_6.setStretch(3, 2)
         self.verticalLayout_6.setStretch(4, 2)
@@ -2088,7 +2156,8 @@ class Ui_PrimaryWindow(object):
         self.verticalLayout_6.setStretch(8, 2)
         self.verticalLayout_6.setStretch(9, 2)
         self.verticalLayout_6.setStretch(10, 2)
-        self.verticalLayout_6.setStretch(11, 3)
+        self.verticalLayout_6.setStretch(11, 2)
+        self.verticalLayout_6.setStretch(12, 3)
 
         self.settings_tab_layout.addLayout(self.verticalLayout_6, 0, 0, 1, 1)
 
@@ -2150,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)
         )
@@ -2165,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)
@@ -2179,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)
         )
@@ -2221,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)
         )
@@ -2252,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
@@ -2279,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
@@ -2352,6 +2473,16 @@ class Ui_PrimaryWindow(object):
         self.label_3.setText(QCoreApplication.translate("PrimaryWindow", "0", None))
         self.enable_state_0.setText("")
         self.state_scored_0.setText("")
+        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

@@ -164,6 +164,9 @@
                   <verstretch>0</verstretch>
                  </sizepolicy>
                 </property>
+                <property name="alignment">
+                 <set>Qt::AlignmentFlag::AlignLeading|Qt::AlignmentFlag::AlignLeft|Qt::AlignmentFlag::AlignVCenter</set>
+                </property>
                 <property name="maximum">
                  <double>100000.000000000000000</double>
                 </property>
@@ -260,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>
@@ -273,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>
@@ -284,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>
@@ -512,6 +541,9 @@ color: rgb(244, 195, 68);</string>
                        <verstretch>0</verstretch>
                       </sizepolicy>
                      </property>
+                     <property name="alignment">
+                      <set>Qt::AlignmentFlag::AlignLeading|Qt::AlignmentFlag::AlignLeft|Qt::AlignmentFlag::AlignVCenter</set>
+                     </property>
                      <property name="minimum">
                       <double>0.000000000000000</double>
                      </property>
@@ -556,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>
@@ -747,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>
@@ -807,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>
@@ -982,6 +1023,9 @@ color: rgb(244, 195, 68);</string>
                               <verstretch>0</verstretch>
                              </sizepolicy>
                             </property>
+                            <property name="alignment">
+                             <set>Qt::AlignmentFlag::AlignLeading|Qt::AlignmentFlag::AlignLeft|Qt::AlignmentFlag::AlignVCenter</set>
+                            </property>
                             <property name="decimals">
                              <number>2</number>
                             </property>
@@ -1033,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>
@@ -1287,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>
@@ -1465,7 +1515,7 @@ color: rgb(244, 195, 68);</string>
            </layout>
           </item>
           <item row="0" column="0">
-           <layout class="QVBoxLayout" name="verticalLayout_6" stretch="2,0,2,2,2,2,2,2,2,2,2,3">
+           <layout class="QVBoxLayout" name="verticalLayout_6" stretch="2,2,2,2,2,2,2,2,2,2,2,2,3">
             <item>
              <layout class="QHBoxLayout" name="horizontalLayout_3" stretch="3,3,4,3,4">
               <property name="spacing">
@@ -3446,6 +3496,75 @@ color: rgb(244, 195, 68);</string>
               </item>
              </layout>
             </item>
+            <item>
+             <layout class="QHBoxLayout" name="default_epoch_layout">
+              <item>
+               <spacer name="horizontalSpacer_71">
+                <property name="orientation">
+                 <enum>Qt::Orientation::Horizontal</enum>
+                </property>
+                <property name="sizeType">
+                 <enum>QSizePolicy::Policy::Preferred</enum>
+                </property>
+                <property name="sizeHint" stdset="0">
+                 <size>
+                  <width>10</width>
+                  <height>10</height>
+                 </size>
+                </property>
+               </spacer>
+              </item>
+              <item>
+               <layout class="QHBoxLayout" name="horizontalLayout_60">
+                <item>
+                 <widget class="QLabel" name="label_17">
+                  <property name="sizePolicy">
+                   <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
+                    <horstretch>0</horstretch>
+                    <verstretch>0</verstretch>
+                   </sizepolicy>
+                  </property>
+                  <property name="text">
+                   <string>Default epoch length:</string>
+                  </property>
+                 </widget>
+                </item>
+                <item>
+                 <widget class="QDoubleSpinBox" name="default_epoch_input">
+                  <property name="sizePolicy">
+                   <sizepolicy hsizetype="Fixed" vsizetype="Fixed">
+                    <horstretch>0</horstretch>
+                    <verstretch>0</verstretch>
+                   </sizepolicy>
+                  </property>
+                  <property name="maximum">
+                   <double>100000.000000000000000</double>
+                  </property>
+                  <property name="singleStep">
+                   <double>0.500000000000000</double>
+                  </property>
+                 </widget>
+                </item>
+               </layout>
+              </item>
+              <item>
+               <spacer name="horizontalSpacer_70">
+                <property name="orientation">
+                 <enum>Qt::Orientation::Horizontal</enum>
+                </property>
+                <property name="sizeType">
+                 <enum>QSizePolicy::Policy::Preferred</enum>
+                </property>
+                <property name="sizeHint" stdset="0">
+                 <size>
+                  <width>10</width>
+                  <height>10</height>
+                 </size>
+                </property>
+               </spacer>
+              </item>
+             </layout>
+            </item>
             <item>
              <layout class="QHBoxLayout" name="horizontalLayout_18" stretch="6,1,7">
               <property name="spacing">
@@ -3475,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,5 @@
 This is the current brain state configuration.
-If you change it, click 'Save' to store the changes.
+If you make changes, click 'Save' to store them.
 
 Each brain state has several attributes:
 
@@ -25,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.txt → main_guide_text.py}

@@ -1,8 +1,31 @@
+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
 -----------------------------------------------------------------------
@@ -40,18 +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 match the
-    ones listed in constants.py (EEG_COL, EMG_COL).
-Label file: a .csv file with one column whose title matches
-    BRAIN_STATE_COL in config.py, with entries that are either the
-    undefined brain state (UNDEFINED_LABEL) or one of the valid
-    "digit" attributes of your brain states. By default, these are 1-3
-    and REM = 1, wake = 2, NREM = 3.
+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.
+    for details. These have {CALIBRATION_FILE_TYPE} format.
 Trained classification model: required for automatic labeling. See
-    Section 4 for details.
+    Section 4 for details. These have {MODEL_FILE_TYPE} format.
 
 -----------------------------------------------------------------------
 Section 3: Manually assigning brain state labels
@@ -75,6 +97,12 @@ Section 4: Automatically scoring recordings with a classification model
 Automatic brain state scoring requires the inputs described in
 Section 3, as well as calibration data files and a trained classifier.
 If you already have all of these files, proceed to Section 4C.
+Models trained on the AccuSleep dataset are provided at
+https://osf.io/py5eb under /python_format/models/ for epoch lengths of
+2.5, 4, 5, and 10 seconds. These models are the "default" type, in that
+they use several epochs of data before and after any given epoch when
+scoring that epoch. (The other model type, called "real-time", only
+uses data from the current epoch and several preceding epochs.)
 
 --- Section 4A: Creating calibration data files ---
 Each recording must have a calibration file assigned to it.
@@ -95,14 +123,12 @@ 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 ---
-Pre-trained classification models are provided with AccuSleePy for
-epoch lengths of 2.5, 4, 5, and 10 seconds. These models are the
-"default" type, in that they use several epochs of data before and
-after any given epoch when scoring that epoch. (The other model type,
-called "real-time", only uses data from the current epoch and several
-preceding epochs.
 To train a new model on your own data:
 1. Add your scored recordings to the recording list. Make sure the
     sampling rate, recording file, and label file are set for each
@@ -113,11 +139,15 @@ To train a new model on your own data:
     type models, this must be an odd number. In general, about 30
     seconds worth of data is enough.
 4. Choose whether the images used to train the model should be
-    deleted once training is complete.
-5. Select a directory where the training images will be saved. A
+    deleted once training is complete. (It's generally best to
+    leave this box checked.)
+5. Choose whether to create a "default" or "real-time"-type model.
+    Note that scoring recordings in the GUI requires a default-type
+    model.
+6. Select a directory where the training images will be saved. A
     new directory with an automatically generated name will be
     created inside the directory you choose.
-6. Click the "Train classification model" button and enter a
+7. Click the "Train classification model" button and enter a
     filename for the trained model. Training can take some time.
 
 --- Section 4C: Automatic labeling ---
@@ -127,8 +157,8 @@ Instructions for automatic labeling using this GUI are below.
     for each recording. See section 4A for instructions on creating
     calibration files.
 3. Click 'Load classification model' to load the trained classification
-    model. The epoch length used when training this network should be
-    the same as the current epoch length.
+    model. It's important that the epoch length used when training this
+    model is the same as the current epoch length.
 4. If you wish to preserve any existing labels in the label file, and
     only overwrite undefined epochs, check the box labeled
     'Only overwrite undefined epochs'.
@@ -140,3 +170,4 @@ Instructions for automatic labeling using this GUI are below.
     recording list. Labels will be saved to the file specified by
     the 'Select or create label file' field of each recording. You can
     click 'Score manually' to visualize the results.
+"""

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: accusleepy
-Version: 0.1.2
+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)
@@ -30,16 +31,19 @@ Description-Content-Type: text/markdown
 ## Description
 
 AccuSleePy is a python implementation of AccuSleep--a set of graphical user interfaces for scoring rodent
-sleep using EEG and EMG recordings. If you use AccuSleep in your research, please cite our
+sleep using EEG and EMG recordings. It offers several improvements over the original MATLAB version
+and is the only version that will be actively maintained.
+
+If you use AccuSleep in your research, please cite our
 [publication](https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0224642):
 
 Barger, Z., Frye, C. G., Liu, D., Dan, Y., & Bouchard, K. E. (2019). Robust, automated sleep scoring by a compact neural network with distributional shift correction. *PLOS ONE, 14*(12), 1–18.
 
-The data used for training and testing AccuSleep are available at https://osf.io/py5eb/
+The data and models associated with AccuSleep are available at https://osf.io/py5eb/
 
 Please contact zekebarger (at) gmail (dot) com with any questions or comments about the software.
 
-## Installation instructions
+## Installation
 
 - (recommended) create a new virtual environment (using
 [venv](https://docs.python.org/3/library/venv.html),
@@ -47,10 +51,11 @@ Please contact zekebarger (at) gmail (dot) com with any questions or comments ab
 etc.) using python >=3.10,<3.13
 - (optional) if you have a CUDA device and want to speed up model training, [install PyTorch](https://pytorch.org/)
 - `pip install accusleepy`
+- (optional) download a classification model from https://osf.io/py5eb/ under /python_format/models/
 
 ## Usage
 
-`python -m accusleepy`
+`python -m accusleepy` will open the primary interface.
 
 ## Acknowledgements
 

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

@@ -2,9 +2,9 @@ accusleepy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 accusleepy/__main__.py,sha256=dKzl2N2Hg9lD264CWYNxThRyDKzWwyMwHRXmJxOmMis,104
 accusleepy/brain_state_set.py,sha256=fRkrArHLIbEKimub804yt_mUXoyfsjJEfiJnTjeCMkY,3233
 accusleepy/classification.py,sha256=xrmPyMHlzYh0QfNCID1PRIYEIyNkWduOi7g1Bdb6xfg,8573
-accusleepy/config.json,sha256=GZV0d1E44NEj-P7X5GKjbxbjjYKWUtXAm29a3vGABVA,430
-accusleepy/constants.py,sha256=ceRcWmhec5sATiAsIynf3XFKl0H2IsT_JDfeg7xYbqg,1189
-accusleepy/fileio.py,sha256=ojuzDkcJkXok9dny75g8LDieKeMT7P2SFVLyJek6Nd8,6011
+accusleepy/config.json,sha256=F76WRLarMEW38BBMPwFlQ_d7Dur-ptqYmW8BxqnQF4A,464
+accusleepy/constants.py,sha256=PnsPANggyIfMfd6OCR-kNztFOTybUEhMnPeibu5_eEU,1280
+accusleepy/fileio.py,sha256=S5pf_hE-btJPMbrTplKLaQTULSJQoOJ-56LBH79Uz3I,6383
 accusleepy/gui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 accusleepy/gui/icons/brightness_down.png,sha256=PLT1fb83RHIhSRuU7MMMx0G7oJAY7o9wUcnqM8veZfM,12432
 accusleepy/gui/icons/brightness_up.png,sha256=64GnUqgPvN5xZ6Um3wOzwqvUmdAWYZT6eFmWpBsHyks,12989
@@ -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=8W2UvYwEvVXNS88Z5MoAOnyj5jmsRG-c_lXk58WnI98,53049
-accusleepy/gui/manual_scoring.py,sha256=Ce-X4A7pm3Hb0PtiqebF59rpSEMcHhWWhoO-L7rYtTE,40677
+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=1CsHrX9jenL_22imlnI4CDsNUYVCfrDwI2lR4tapcgU,99422
-accusleepy/gui/primary_window.ui,sha256=r4d3g7CRC2DZof9FjR12lid1kxWP3wb5JpPuPm0ijY0,141515
+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=4JL9rPd8yr6aYHborzx5c1GQlq8r0_sckINzqmNoNjw,1031
-accusleepy/gui/text/main_guide.txt,sha256=bIDL8SQKK88MhVqmgKYQWygR4oSfS-CsKNuUUOi2hzU,7684
+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.1.2.dist-info/METADATA,sha256=UiI9nm7G9U9v5m-UqHA8Uy035XNZh2Ud84ygcV-W9Oc,2488
-accusleepy-0.1.2.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-accusleepy-0.1.2.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,,