spectre-core 0.0.3__tar.gz → 0.0.5__tar.gz

{spectre_core-0.0.3 → spectre_core-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spectre-core
-Version: 0.0.3
+Version: 0.0.5
 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.3 → spectre_core-0.0.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "spectre-core"
-version = "0.0.3"
+version = "0.0.5"
 maintainers = [
   { name="Jimmy Fitzpatrick", email="jcfitzpatrick12@gmail.com" },
 ]

{spectre_core-0.0.3 → spectre_core-0.0.5}/src/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-0.0.3 → spectre_core-0.0.5}/src/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-0.0.3 → spectre_core-0.0.5}/src/spectre_core/file_handlers/base.py

@@ -56,39 +56,13 @@ class BaseFileHandler(ABC):
         os.makedirs(self.parent_path, exist_ok=True) 
     
 
-    def delete(self, 
-               doublecheck_delete = True) -> 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:
-            if doublecheck_delete:
-                self.doublecheck_delete()
             os.remove(self.file_path)
     
 
     def cat(self) -> None:
-        print(self.read())
-
-
-    def _doublecheck_action(self, 
-                            action_message: str) -> None:
-        proceed_with_action = False
-        while not proceed_with_action:
-            user_input = input(f"{action_message} [y/n]: ").strip().lower()
-            if user_input == "y":
-                proceed_with_action = True
-            elif user_input == "n":
-                print("Operation cancelled by the user")
-                raise exit(1)
-            else:
-                print(f"Please enter one of [y/n], received {user_input}")
-                proceed_with_action = False
-
-
-    def doublecheck_overwrite(self) -> None:
-        self._doublecheck_action(action_message=f"The file '{self.file_path}' already exists. Overwrite?")
-
-
-    def doublecheck_delete(self) -> None:
-        self._doublecheck_action(action_message=f"Are you sure you would like to delete '{self.file_path}'?")
+        print(self.read())

{spectre_core-0.0.3 → spectre_core-0.0.5}/src/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)
 
 
@@ -239,12 +239,14 @@ class FitsConfig(SPECTREConfig):
 
     def save_params(self, 
                     params: list[str], 
-                    doublecheck_overwrite: bool = True
+                    force: bool = False
                     ) -> None:
         d = type_cast_params(params, 
                              self.type_template)
+        validate_against_type_template(d, 
+                                       self.type_template)
         self.save(d, 
-                  doublecheck_overwrite = doublecheck_overwrite)
+                  force = force)
         
     
 class CaptureConfig(SPECTREConfig):

{spectre_core-0.0.3 → spectre_core-0.0.5}/src/spectre_core/file_handlers/json.py

@@ -26,11 +26,15 @@ class JsonHandler(BaseFileHandler):
 
     def save(self, 
              d: dict, 
-             doublecheck_overwrite: bool = True) -> None:
+             force: bool = False) -> None:
         self.make_parent_path()
 
-        if self.exists and doublecheck_overwrite:
-            self.doublecheck_overwrite()
-        
+        if self.exists:
+            if force:
+                pass
+            else:
+                raise RuntimeError((f"{self.file_name} already exists, write has been abandoned. "
+                                    f"You can override this functionality with `force`"))
+
         with open(self.file_path, 'w') as file:
-            json.dump(d, file, indent=4)
+                json.dump(d, file, indent=4)

{spectre_core-0.0.3 → spectre_core-0.0.5}/src/spectre_core/logging.py

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

{spectre_core-0.0.3 → spectre_core-0.0.5}/src/spectre_core/receivers/base.py

@@ -155,7 +155,7 @@ class BaseReceiver(ABC):
     def save_params(self, 
                     params: list[str],  
                     tag: str, 
-                    doublecheck_overwrite: bool = True) -> None:
+                    force: bool = False) -> None:
         d = type_cast_params(params, 
                              self.type_template)
         
@@ -164,13 +164,13 @@ class BaseReceiver(ABC):
         
         self.save_capture_config(d, 
                                  tag, 
-                                 doublecheck_overwrite=doublecheck_overwrite)
+                                 force = force)
 
 
     def save_capture_config(self, 
                             d: dict[str, Any],
                             tag: str, 
-                            doublecheck_overwrite: bool = True) -> None:
+                            force: bool = False) -> None:
         
         self.validate_capture_config(d)
 
@@ -180,7 +180,7 @@ class BaseReceiver(ABC):
         
         capture_config = CaptureConfig(tag)
         capture_config.save(d, 
-                            doublecheck_overwrite = doublecheck_overwrite)
+                            force = force)
 
 
     def load_capture_config(self, 
@@ -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-0.0.3 → spectre_core-0.0.5}/src/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': dict, # 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-0.0.3 → spectre_core-0.0.5}/src/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-0.0.3 → spectre_core-0.0.5}/src/spectre_core/spectrograms/analytical.py

@@ -2,7 +2,7 @@
 # This file is part of SPECTRE
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-from typing import Callable
+from typing import Callable, Any
 from dataclasses import dataclass
 
 import numpy as np
@@ -23,15 +23,25 @@ class TestResults:
     # Maps each time to whether the corresponding spectrum matched analytically
     spectrum_validated: dict[float, bool] = None
 
+
     @property
     def num_validated_spectrums(self) -> int:
         """Counts the number of validated spectrums."""
         return sum(is_validated for is_validated in self.spectrum_validated.values())
 
+
     @property
     def num_invalid_spectrums(self) -> int:
         """Counts the number of spectrums that are not validated."""
         return len(self.spectrum_validated) - self.num_validated_spectrums
+    
+
+    def jsonify(self) -> dict[str, Any]:
+        return {
+            "times_validated": self.times_validated,
+            "frequencies_validated": self.frequencies_validated,
+            "spectrum_validated": self.spectrum_validated
+        }
 
 
 class _AnalyticalFactory:
@@ -82,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)
@@ -182,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-0.0.3 → spectre_core-0.0.5}/src/spectre_core/watchdog/library/fixed/event_handler.py

@@ -34,8 +34,8 @@ class EventHandler(BaseEventHandler):
 
         bin_chunk = chunk.get_file('bin')
         _LOGGER.info(f"Deleting {bin_chunk.file_path}")
-        bin_chunk.delete(doublecheck_delete = False)
+        bin_chunk.delete()
 
         hdr_chunk = chunk.get_file('hdr')
         _LOGGER.info(f"Deleting {hdr_chunk.file_path}")
-        hdr_chunk.delete(doublecheck_delete = False)
+        hdr_chunk.delete()

{spectre_core-0.0.3 → spectre_core-0.0.5}/src/spectre_core/watchdog/library/sweep/event_handler.py

@@ -45,11 +45,11 @@ class EventHandler(BaseEventHandler):
         else:
             bin_chunk = self.previous_chunk.get_file('bin')
             _LOGGER.info(f"Deleting {bin_chunk.file_path}")
-            bin_chunk.delete(doublecheck_delete = False)
+            bin_chunk.delete()
 
             hdr_chunk = self.previous_chunk.get_file('hdr')
             _LOGGER.info(f"Deleting {hdr_chunk.file_path}")
-            hdr_chunk.delete(doublecheck_delete = False)
+            hdr_chunk.delete()
 
             # and reassign the current chunk to be used as the previous chunk at the next call of this method
             self.previous_chunk = chunk

{spectre_core-0.0.3 → spectre_core-0.0.5}/src/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.3 → spectre_core-0.0.5}/src/spectre_core.egg-info/PKG-INFO

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