Make use of waveforms_dir consistent (#857)

* make use of waveforms_dir consistent

* update changelog

---------

Co-authored-by: Eric Denovellis <[email protected]>

Author: samuelbray32

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Infrastructure
 
 - Add user roles to `database_settings.py`. #832
+- Fix redundancy in `waveforms_dir` #857
 - Revise `dj_chains` to permit undirected paths for paths with multiple Merge
     Tables. #846
 

src/spyglass/decoding/v0/clusterless.py

@@ -21,7 +21,7 @@
 import spikeinterface as si
 import xarray as xr
 
-from spyglass.settings import waveform_dir
+from spyglass.settings import waveforms_dir
 from spyglass.utils import logger
 
 try:
@@ -157,7 +157,7 @@ def make(self, key):
             f'{key["curation_id"]}_clusterless_waveforms'
         )
         waveform_extractor_path = str(
-            Path(waveform_dir) / Path(waveform_extractor_name)
+            Path(waveforms_dir) / Path(waveform_extractor_name)
         )
         if os.path.exists(waveform_extractor_path):
             shutil.rmtree(waveform_extractor_path)

src/spyglass/settings.py

@@ -509,10 +509,6 @@ def waveforms_dir(self) -> str:
     def temp_dir(self) -> str:
         return self.config.get(self.dir_to_var("temp"))
 
-    @property
-    def waveform_dir(self) -> str:
-        return self.config.get(self.dir_to_var("waveform"))
-
     @property
     def video_dir(self) -> str:
         return self.config.get(self.dir_to_var("video"))
@@ -559,7 +555,7 @@ def dlc_output_dir(self) -> str:
     temp_dir = None
     analysis_dir = None
     sorting_dir = None
-    waveform_dir = None
+    waveforms_dir = None
     video_dir = None
     dlc_project_dir = None
     dlc_video_dir = None
@@ -572,7 +568,7 @@ def dlc_output_dir(self) -> str:
     temp_dir = sg_config.temp_dir
     analysis_dir = sg_config.analysis_dir
     sorting_dir = sg_config.sorting_dir
-    waveform_dir = sg_config.waveform_dir
+    waveforms_dir = sg_config.waveforms_dir
     video_dir = sg_config.video_dir
     debug_mode = sg_config.debug_mode
     test_mode = sg_config.test_mode

src/spyglass/spikesorting/v0/spikesorting_curation.py

@@ -15,7 +15,7 @@
 
 from spyglass.common.common_interval import IntervalList
 from spyglass.common.common_nwbfile import AnalysisNwbfile
-from spyglass.settings import waveform_dir
+from spyglass.settings import waveforms_dir
 from spyglass.spikesorting.v0.merged_sorting_extractor import (
     MergedSortingExtractor,
 )
@@ -331,7 +331,7 @@ def make(self, key):
 
         waveform_extractor_name = self._get_waveform_extractor_name(key)
         key["waveform_extractor_path"] = str(
-            Path(waveform_dir) / Path(waveform_extractor_name)
+            Path(waveforms_dir) / Path(waveform_extractor_name)
         )
         if os.path.exists(key["waveform_extractor_path"]):
             shutil.rmtree(key["waveform_extractor_path"])
@@ -513,7 +513,7 @@ def make(self, key):
             qm[metric_name] = metric
         qm_name = self._get_quality_metrics_name(key)
         key["quality_metrics_path"] = str(
-            Path(waveform_dir) / Path(qm_name + ".json")
+            Path(waveforms_dir) / Path(qm_name + ".json")
         )
         # save metrics dict as json
         logger.info(f"Computed all metrics: {qm}")