spectre-core 0.0.4__py3-none-any.whl → 0.0.6__py3-none-any.whl

spectre_core/cfg.py

@@ -18,9 +18,9 @@ LOGS_DIR_PATH = os.environ.get("SPECTRE_LOGS_DIR_PATH",
 os.makedirs(LOGS_DIR_PATH, 
             exist_ok=True)
 
-JSON_CONFIGS_DIR_PATH = os.environ.get("SPECTRE_JSON_CONFIGS_DIR_PATH",
-                                       os.path.join(SPECTRE_DATA_DIR_PATH, "configs"))
-os.makedirs(JSON_CONFIGS_DIR_PATH, 
+CONFIGS_DIR_PATH = os.environ.get("SPECTRE_CONFIGS_DIR_PATH",
+                                  os.path.join(SPECTRE_DATA_DIR_PATH, "configs"))
+os.makedirs(CONFIGS_DIR_PATH, 
             exist_ok=True)
 
 DEFAULT_TIME_FORMAT = "%H:%M:%S"

spectre_core/chunks/base.py

@@ -147,6 +147,7 @@ class SPECTREChunk(BaseChunk):
     
 
     def __get_SFT_instance(self) -> ShortTimeFFT:
+        hop = self.capture_config.get("hop")
         window_type = self.capture_config.get("window_type")
         window_params = self.capture_config.get("window_kwargs").values()
         window_size = self.capture_config.get("window_size")
@@ -155,6 +156,6 @@ class SPECTREChunk(BaseChunk):
                              window_size)
         samp_rate = self.capture_config.get("samp_rate")
         return ShortTimeFFT(window, 
-                            fs=samp_rate, 
-                            fft_mode="centered", 
-                            **self.capture_config.get("STFFT_kwargs"))
+                            hop,
+                            samp_rate, 
+                            fft_mode = "centered")

spectre_core/file_handlers/base.py

@@ -56,10 +56,10 @@ class BaseFileHandler(ABC):
         os.makedirs(self.parent_path, exist_ok=True) 
     
 
-    def delete(self) -> None:
-        if not self.exists:
-            warn(f"{self.file_path} does not exist. No deletion taking place")
-            return
+    def delete(self,
+               ignore_if_missing: bool = False) -> None:
+        if not self.exists and not ignore_if_missing:
+            raise FileNotFoundError(f"{self.file_name} does not exist, and so cannot be deleted")
         else:
             os.remove(self.file_path)
     

spectre_core/file_handlers/configs.py

@@ -7,7 +7,7 @@ from abc import ABC
 import ast
 
 from spectre_core.file_handlers.json import JsonHandler
-from spectre_core.cfg import JSON_CONFIGS_DIR_PATH
+from spectre_core.cfg import CONFIGS_DIR_PATH
 from spectre_core.exceptions import InvalidTagError
 
 
@@ -146,8 +146,8 @@ class SPECTREConfig(JsonHandler, ABC):
         self._config_type = config_type
 
         self._dict = None # cache
-        super().__init__(JSON_CONFIGS_DIR_PATH, 
-                         f"{config_type}_config_{tag}", 
+        super().__init__(CONFIGS_DIR_PATH, 
+                         f"{config_type}_{tag}", 
                          **kwargs)
 
 

spectre_core/logging.py

@@ -22,8 +22,8 @@ from spectre_core.cfg import (
 )
 
 PROCESS_TYPES = [
-    "USER", 
-    "WORKER"
+    "user", 
+    "worker"
 ]
 
 

spectre_core/receivers/base.py

@@ -239,7 +239,7 @@ class SPECTREReceiver(BaseReceiver):
                 "window_type": str, # window type for STFFT
                 "window_kwargs": dict, # keyword arguments for window function, must be in order as in scipy documentation.
                 "window_size": int, # number of samples in STFFT window
-                "STFFT_kwargs": dict, # keyword arguments for the scipy STFFT class
+                "hop": int, # STFFT window hops by so many samples
                 "chunk_key": str, # tag will map to the chunk with this key
                 "event_handler_key": str, # tag will map to event handler with this key during post processing
             },
@@ -259,7 +259,7 @@ class SPECTREReceiver(BaseReceiver):
                 "window_type": str, # window type for STFFT
                 "window_kwargs": dict, # keyword arguments for window function, must be in order as in scipy documentation.
                 "window_size": int, # number of samples in STFFT window
-                "STFFT_kwargs": dict, # keyword arguments for the scipy STFFT class
+                "hop": int, # keyword arguments for the scipy STFFT class
                 "chunk_key": str, # tag will map to the chunk with this key
                 "event_handler_key": str, # tag will map to event handler with this key during post processing
             }
@@ -289,7 +289,7 @@ class SPECTREReceiver(BaseReceiver):
         window_type = capture_config["window_type"]
         window_kwargs = capture_config["window_kwargs"]
         window_size = capture_config["window_size"]
-        STFFT_kwargs = capture_config["STFFT_kwargs"]
+        hop = capture_config["hop"]
         chunk_key = capture_config["chunk_key"]
         event_handler_key = capture_config[ "event_handler_key"]
 
@@ -307,7 +307,7 @@ class SPECTREReceiver(BaseReceiver):
                           window_size,
                           chunk_size,
                           samp_rate)
-        validators.STFFT_kwargs(STFFT_kwargs)
+        validators.hop(hop)
         validators.chunk_key(chunk_key, "sweep")
         validators.event_handler_key(event_handler_key, "sweep")
         validators.gain_is_negative(IF_gain)
@@ -347,7 +347,7 @@ class SPECTREReceiver(BaseReceiver):
         window_type = capture_config["window_type"]
         window_kwargs = capture_config["window_kwargs"]
         window_size = capture_config["window_size"]
-        STFFT_kwargs = capture_config["STFFT_kwargs"]
+        hop = capture_config["hop"]
         chunk_key = capture_config["chunk_key"]
         event_handler_key = capture_config["event_handler_key"]
 
@@ -362,7 +362,7 @@ class SPECTREReceiver(BaseReceiver):
                           window_size,
                           chunk_size,
                           samp_rate)
-        validators.STFFT_kwargs(STFFT_kwargs)
+        validators.hop(hop)
         validators.chunk_key(chunk_key, 
                              "fixed")
         validators.event_handler_key(event_handler_key, 

spectre_core/receivers/library/test/receiver.py

@@ -43,7 +43,7 @@ class Receiver(SPECTREReceiver):
                 'window_type': str, # the window type for the STFFT
                 'window_kwargs': dict, # keyword arguments for scipy get window function. Must be in order as in scipy documentation.
                 'window_size': int, # number of samples for the window
-                'STFFT_kwargs': dict, # keyword arguments for scipy STFFT class
+                'hop': int, # STFFT hop shifts window by so many samples
                 'chunk_key': str, # tag will map to the chunk with this key
                 'event_handler_key': str # tag will map to event handler with this key during post processing
             },
@@ -60,7 +60,7 @@ class Receiver(SPECTREReceiver):
                 'window_type': str, # the window type for the STFFT
                 'window_kwargs': dict, # keyword arguments for scipy get window function. Must be in order as in scipy documentation.
                 'window_size': int, # number of samples for the window
-                'STFFT_kwargs': dict, # keyword arguments for scipy STFFT class
+                'hop': int, # keyword arguments for scipy STFFT class
                 'chunk_key': str, # tag will map to the chunk with this key
                 'event_handler_key': str, # tag will map to event handler with this key during post processing
             }
@@ -87,7 +87,7 @@ class Receiver(SPECTREReceiver):
         chunk_size = capture_config["chunk_size"]
         window_type = capture_config["window_type"]
         window_size = capture_config["window_size"]
-        STFFT_kwargs = capture_config["STFFT_kwargs"]
+        hop = capture_config["hop"]
         chunk_key = capture_config["chunk_key"]
         event_handler_key = capture_config["event_handler_key"]
         time_resolution = capture_config["time_resolution"]
@@ -101,7 +101,7 @@ class Receiver(SPECTREReceiver):
                                           window_size,
                                           chunk_size,
                                           samp_rate)
-        validators.STFFT_kwargs(STFFT_kwargs)
+        validators.hop(hop)
         validators.chunk_key(chunk_key, "fixed")
         validators.event_handler_key(event_handler_key, "fixed")
 
@@ -145,7 +145,7 @@ class Receiver(SPECTREReceiver):
         window_type = capture_config["window_type"]
         window_kwargs = capture_config["window_kwargs"]
         window_size = capture_config["window_size"]
-        STFFT_kwargs = capture_config["STFFT_kwargs"]
+        hop = capture_config["hop"]
         chunk_key = capture_config["chunk_key"]
         event_handler_key = capture_config["event_handler_key"]
         time_resolution = capture_config["time_resolution"]
@@ -154,7 +154,7 @@ class Receiver(SPECTREReceiver):
         validators.chunk_size_strictly_positive(chunk_size)
         validators.time_resolution(time_resolution, chunk_size)
         validators.window(window_type, window_kwargs, window_size, chunk_size, samp_rate)
-        validators.STFFT_kwargs(STFFT_kwargs)
+        validators.hop(hop)
         validators.chunk_key(chunk_key, "sweep")
         validators.event_handler_key(event_handler_key, "sweep")
 

spectre_core/receivers/validators.py

@@ -69,20 +69,8 @@ def window(window_type: str,
         raise Exception(f"An error has occurred while validating the window. Received: {str(e)}")
     
 
-def STFFT_kwargs(STFFT_kwargs: dict):
-    if len(STFFT_kwargs) == 0:
-        raise ValueError("STFFT kwargs cannot be empty")
-    
-    STFFT_keys = STFFT_kwargs.keys()
-    if "hop" not in STFFT_keys:
-        raise KeyError(f"\"hop\" is a required key in STFFT kwargs. Received: {STFFT_keys}")
-    
-    hop_value = STFFT_kwargs.get("hop")
-    hop_value_type = type(hop_value)
-    if hop_value_type != int:
-        raise TypeError(f"\"hop\" must be specified as an integer. Received: {hop_value_type}")
-    
-    if hop_value < 0:
+def hop(hop: int):
+    if hop < 0:
         raise ValueError(f"\"hop\" must be strictly positive. Received: {hop_value}")
     
     

spectre_core/spectrograms/analytical.py

@@ -38,7 +38,7 @@ class TestResults:
 
     def jsonify(self) -> dict[str, Any]:
         return {
-            "time_validated": self.times_validated,
+            "times_validated": self.times_validated,
             "frequencies_validated": self.frequencies_validated,
             "spectrum_validated": self.spectrum_validated
         }
@@ -92,7 +92,7 @@ class _AnalyticalFactory:
         samp_rate = capture_config['samp_rate']
         amplitude = capture_config['amplitude']
         frequency = capture_config['frequency']
-        hop = capture_config['STFFT_kwargs']['hop']
+        hop = capture_config['hop']
 
         # Calculate derived parameters a (sampling rate ratio) and p (sampled periods).
         a = int(samp_rate / frequency)
@@ -192,24 +192,21 @@ def validate_analytically(spectrogram: Spectrogram,
 
     test_results = TestResults()
 
-    if is_close(analytical_spectrogram.times,
-                spectrogram.times,
-                absolute_tolerance):
-        test_results.times_validated = True
+    test_results.times_validated = bool(is_close(analytical_spectrogram.times,
+                                                 spectrogram.times,
+                                                 absolute_tolerance))
 
-
-    if is_close(analytical_spectrogram.frequencies,
-                spectrogram.frequencies,
-                absolute_tolerance):
-        test_results.frequencies_validated = True
+    test_results.frequencies_validated = bool(is_close(analytical_spectrogram.frequencies,
+                                                       spectrogram.frequencies,
+                                                       absolute_tolerance))
 
     test_results.spectrum_validated = {}
     for i in range(spectrogram.num_times):
         time = spectrogram.times[i]
         analytical_spectrum = analytical_spectrogram.dynamic_spectra[:, i]
         spectrum = spectrogram.dynamic_spectra[:, i]
-        test_results.spectrum_validated[time] = is_close(analytical_spectrum, 
-                                                         spectrum,
-                                                         absolute_tolerance)
+        test_results.spectrum_validated[time] = bool(is_close(analytical_spectrum, 
+                                                              spectrum,
+                                                              absolute_tolerance))
 
     return test_results

spectre_core/web_fetch/callisto.py

@@ -15,7 +15,7 @@ from spectre_core.cfg import (
 )
 from spectre_core.cfg import get_chunks_dir_path
 
-temp_dir = os.path.join(os.environ['SPECTRE_DIR_PATH'], "tmp")
+temp_dir = os.path.join(os.environ['SPECTRE_DATA_DIR_PATH'], "tmp")
 
 def get_chunk_name(station: str, date: str, time: str, instrument_code: str) -> str:
     dt = datetime.strptime(f"{date}T{time}", '%Y%m%dT%H%M%S')

{spectre_core-0.0.4.dist-info → spectre_core-0.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spectre-core
-Version: 0.0.4
+Version: 0.0.6
 Summary: The core Python package used by the spectre program. 
 Maintainer-email: Jimmy Fitzpatrick <jcfitzpatrick12@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE

{spectre_core-0.0.4.dist-info → spectre_core-0.0.6.dist-info}/RECORD

@@ -1,10 +1,10 @@
 spectre_core/__init__.py,sha256=oFSWmGoXQLK5X5xHvWzTdNr9amuaiiGjZirXZVogACU,154
-spectre_core/cfg.py,sha256=_CkQRKRtbkOJmSV58bW4lCsyuRell9dw1lwmirm4Jfc,3175
+spectre_core/cfg.py,sha256=v9_yxV63rHMcSAsAFbWFBRDeElgcrDdY3yzGXFGJyxQ,3155
 spectre_core/dynamic_imports.py,sha256=hZbFA9QSVUmAA779qrwHe6RylpjeAG_L2KTVrRZE-Qk,987
 spectre_core/exceptions.py,sha256=i1uLL64DLESdzXTAPTsqc4Yg6LeU-ItOm5rhDlrDv7w,663
-spectre_core/logging.py,sha256=mdTqHLHXm5ES0nsajy_b7SqT6P2SvMfFfqGg3QOU2F8,6486
+spectre_core/logging.py,sha256=wxhi9UubjfKtd5lpG3tklr8lJDDR0cUoA3y4GLK6wE8,6486
 spectre_core/chunks/__init__.py,sha256=KqEz43Ifjbw_1cMdxt4s7iEUCOGmFruNN63qU2mgcmY,7148
-spectre_core/chunks/base.py,sha256=lVqVOmI5mxP7JUZ8Gf1VLAQuS3D8q0g7r_ipphxbTBo,5091
+spectre_core/chunks/base.py,sha256=wl2jqPTcmpK8uxnl85lDcEmpOrvZ55AvdmCdtphI3xs,5096
 spectre_core/chunks/chunk_register.py,sha256=sS-T6d59zbh8_trr_7bYlq2O9Ak7k_XXHM6-yalwxaE,435
 spectre_core/chunks/factory.py,sha256=gi0x7nsZZR8HUBxnpEfwZG5fI1jSzM2OVPwGR8i45YE,1133
 spectre_core/chunks/library/__init__.py,sha256=w2G2Ew_yLK1q--1pwN-UsDSSa73Z6VHnn3jC-XXQNWE,272
@@ -14,8 +14,8 @@ spectre_core/chunks/library/fixed/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeR
 spectre_core/chunks/library/fixed/chunk.py,sha256=ckBiEtSa6_S06d_H9LQ0ske5JT2ycF-LstWbDX1oo1c,6941
 spectre_core/chunks/library/sweep/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 spectre_core/chunks/library/sweep/chunk.py,sha256=bXpC43kylsaAc88VEc0lnLy8AFXZivejqXUyovDz51U,21219
-spectre_core/file_handlers/base.py,sha256=V1R6Vbp3mjA29TI_y4bpslhVvCQT7nzmGY4lDLlN2iI,1653
-spectre_core/file_handlers/configs.py,sha256=CiNHfy5lGrXDAcxCrKS9VE5Z1Aonp0CP9-SxlyP-ZHI,8500
+spectre_core/file_handlers/base.py,sha256=PbZkgCeZnkkO0TstuFf39oXh8VQDzwlEhwMWzplUDB0,1727
+spectre_core/file_handlers/configs.py,sha256=5V_egP1R5uXsCbbG_NcHorpY6wJCderBk0KBT3LM3OI,8483
 spectre_core/file_handlers/json.py,sha256=PBwjtM29jqfa9ozeRIuarkCJBD8uYIKyDCbM1V2GmtE,1230
 spectre_core/file_handlers/text.py,sha256=K84BIab_qmbR5igCVJZu3uE47ykpM_bnsasd3WGNEuo,677
 spectre_core/plotting/__init__.py,sha256=ZRQmBzZ0HWcVDaM5a8AneGbyHwx7dhtBs2z5H8VVspc,192
@@ -30,10 +30,10 @@ spectre_core/plotting/library/integral_over_frequency/panel.py,sha256=tvro2MCtY4
 spectre_core/plotting/library/spectrogram/panel.py,sha256=CAaPz7sDYoWZ3-4Jb1kVRu9bvJYaBRiXvoMkV7QXWqk,3556
 spectre_core/plotting/library/time_cuts/panel.py,sha256=u9Sbnwy6ex61y5Jl-D77HlYvuuXdK8_YB-o2gCovCTY,2947
 spectre_core/receivers/__init__.py,sha256=kKfhqrGs9sSPGLbrpTqScv816iPZOvT3ry3zSMcqLkM,227
-spectre_core/receivers/base.py,sha256=Hx-jH7pnFyeSjaajujmzAYjODUNRgCBo3maHw9rIsyM,16149
+spectre_core/receivers/base.py,sha256=rKfKULYW1m7b3jDHBjnQMJ9F74Z6GTrQCnpXj6Nn0vc,16050
 spectre_core/receivers/factory.py,sha256=aE-Yw_cnlkhRe5HxK0JqhDzd2AwZcKmB2QkAKwaq27Y,873
 spectre_core/receivers/receiver_register.py,sha256=xHcRnT-3NQxyIWL3nyT3P9qT14Wl5liM9HbflOvOUAM,617
-spectre_core/receivers/validators.py,sha256=udwOw92oCFR84JMaaOmWn_Ve9G4RKfzdqhpSpGDPqnY,8974
+spectre_core/receivers/validators.py,sha256=aP8nbRWZxU5pOwBIXTojXuHd3i9yksHW_vIBn4cbKug,8481
 spectre_core/receivers/library/__init__.py,sha256=xmtF5p3_ZkGfso_pKnxSgUcXXFLEBwERGPq1Pek7cOU,274
 spectre_core/receivers/library/rsp1a/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 spectre_core/receivers/library/rsp1a/receiver.py,sha256=xs_aNMhwIYD83KwutizjBziyu9XsfHqGqvQXOFcglz4,2224
@@ -46,12 +46,12 @@ spectre_core/receivers/library/rspduo/gr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5
 spectre_core/receivers/library/rspduo/gr/tuner_1_fixed.py,sha256=YaRS9oNRry-6eZPIsFjNlKcZqhNcQw3X9N8Dw877aeM,3603
 spectre_core/receivers/library/rspduo/gr/tuner_1_sweep.py,sha256=0WDfR1R6uOnIEb_4aPQN-O5Gh62utZrvRukPEF3xzDU,5113
 spectre_core/receivers/library/test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-spectre_core/receivers/library/test/receiver.py,sha256=EShvfoBT7M8Egt9PWHOfaU4RarP3WuQ8dW5yQcxWLQs,8226
+spectre_core/receivers/library/test/receiver.py,sha256=i78ucPZmlRYVqwqrw29kiIhN_VC2KCifig8Xc0JtbRw,8137
 spectre_core/receivers/library/test/gr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 spectre_core/receivers/library/test/gr/cosine_signal_1.py,sha256=6XgYjYMh-QNPs_UUGUQcU_VQFr6BG4OLdsW-M-RU5Ww,2943
 spectre_core/receivers/library/test/gr/tagged_staircase.py,sha256=5rJHbB-3vdXjqT8DrcAGUSebaAqZ5RQtYHBWgH9iU2E,3465
 spectre_core/spectrograms/__init__.py,sha256=OFW82_itCktN8dFm_UO5gbgmzFs51v9KEHrSZWLuIUY,155
-spectre_core/spectrograms/analytical.py,sha256=36XWstSNP4n_8EOi8BFNHl_h2k5JrrtWTXN0CRGVZcI,8535
+spectre_core/spectrograms/analytical.py,sha256=c5X40YgLlutP8sbz6dqODZaCmZ98sAjubO3PtWj7ZZw,8657
 spectre_core/spectrograms/array_operations.py,sha256=6qKd3y2z6Pmu_U8yxTR4FN4eMhS10KgZ8rH60B_IXqw,2577
 spectre_core/spectrograms/spectrogram.py,sha256=EqeQyvjzjoKaXou4vJbPbRx85BeMPB9iiJtFZcCyimI,19488
 spectre_core/spectrograms/transform.py,sha256=xo7ch2lrRkJ54cfIqbkaTHNo_AptBuK0zRELPf7SfIE,13860
@@ -64,9 +64,9 @@ spectre_core/watchdog/library/__init__.py,sha256=vEwAnAV-sv7WcNYOdnjr1JVqZYr29Wr
 spectre_core/watchdog/library/fixed/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 spectre_core/watchdog/library/fixed/event_handler.py,sha256=yWWS80LukB-cTrKBsF4-pRvw2obkX2MzQ5ZGytOtmAg,1387
 spectre_core/watchdog/library/sweep/event_handler.py,sha256=wDISZiQXBeqLDPxgEMo0a2QAXqQVOO7fng3yhZWSR74,2188
-spectre_core/web_fetch/callisto.py,sha256=qiww6IURqNI0Dg5nc4uT8f4GFagWcapSgYkrBoRVmlg,3627
-spectre_core-0.0.4.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-spectre_core-0.0.4.dist-info/METADATA,sha256=KMnQMpsW1dD3TvZtn0wC-xKLjY-WyfnIgm4QHo7is94,42149
-spectre_core-0.0.4.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-spectre_core-0.0.4.dist-info/top_level.txt,sha256=-UsyjpFohXgZpgcZ9QbVeXhsIyF3Am8RxNFNDV_Ta2Y,13
-spectre_core-0.0.4.dist-info/RECORD,,
+spectre_core/web_fetch/callisto.py,sha256=874osjbp61qFwRgV584fpSp7E-xz8g1FEelbNBKhCsw,3632
+spectre_core-0.0.6.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+spectre_core-0.0.6.dist-info/METADATA,sha256=H98Gx3Db495h9gCE7ZkgfP2rUoc0VmnQYCRr4bfieAc,42149
+spectre_core-0.0.6.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+spectre_core-0.0.6.dist-info/top_level.txt,sha256=-UsyjpFohXgZpgcZ9QbVeXhsIyF3Am8RxNFNDV_Ta2Y,13
+spectre_core-0.0.6.dist-info/RECORD,,