spectre-core 0.0.22__py3-none-any.whl → 0.0.23__py3-none-any.whl

spectre_core/spectrograms/_transform.py

@@ -12,10 +12,9 @@ from spectre_core.config import TimeFormat
 from ._array_operations import find_closest_index, average_array, time_elapsed
 from ._spectrogram import Spectrogram
 
+
 def frequency_chop(
-    spectrogram: Spectrogram, 
-    start_frequency  : float, 
-    end_frequency    : float
+    spectrogram: Spectrogram, start_frequency: float, end_frequency: float
 ) -> Spectrogram:
     """
     Extracts a portion of the spectrogram within the specified frequency range.
@@ -27,39 +26,53 @@ def frequency_chop(
     :raises ValueError: If the start and end indices for the frequency range are identical.
     :return: A new spectrogram containing only the specified frequency range.
     """
-    is_entirely_below_frequency_range = (start_frequency < spectrogram.frequencies[0] and end_frequency < spectrogram.frequencies[0])
-    is_entirely_above_frequency_range = (start_frequency > spectrogram.frequencies[-1] and end_frequency > spectrogram.frequencies[-1])
+    is_entirely_below_frequency_range = (
+        start_frequency < spectrogram.frequencies[0]
+        and end_frequency < spectrogram.frequencies[0]
+    )
+    is_entirely_above_frequency_range = (
+        start_frequency > spectrogram.frequencies[-1]
+        and end_frequency > spectrogram.frequencies[-1]
+    )
     if is_entirely_below_frequency_range or is_entirely_above_frequency_range:
-        raise ValueError(f"The requested frequency interval is entirely out of range of the input spectrogram.")
-    
+        raise ValueError(
+            f"The requested frequency interval is entirely out of range of the input spectrogram."
+        )
+
     # find the index of the nearest matching frequency bins in the spectrogram
-    start_index = find_closest_index(np.float32(start_frequency), spectrogram.frequencies)
-    end_index   = find_closest_index(np.float32(end_frequency)  , spectrogram.frequencies)
-    
+    start_index = find_closest_index(
+        np.float32(start_frequency), spectrogram.frequencies
+    )
+    end_index = find_closest_index(np.float32(end_frequency), spectrogram.frequencies)
+
     # enforce distinct start and end indices
     if start_index == end_index:
-        raise ValueError(f"Start and end indices are equal! Got start_index: {start_index} and end_index: {end_index}")  
-    
+        raise ValueError(
+            f"Start and end indices are equal! Got start_index: {start_index} and end_index: {end_index}"
+        )
+
     # if start index is more than end index, swap the ordering so to enforce start_index <= end_index
     if start_index > end_index:
         start_index, end_index = end_index, start_index
-    
+
     # chop the spectrogram accordingly
-    transformed_dynamic_spectra = spectrogram.dynamic_spectra[start_index:end_index+1, :]
-    transformed_frequencies     = spectrogram.frequencies[start_index:end_index+1]
-    
-    return Spectrogram(transformed_dynamic_spectra,
-                       spectrogram.times,
-                       transformed_frequencies,
-                       spectrogram.tag,
-                       spectrogram.spectrum_unit,
-                       spectrogram.start_datetime)
+    transformed_dynamic_spectra = spectrogram.dynamic_spectra[
+        start_index : end_index + 1, :
+    ]
+    transformed_frequencies = spectrogram.frequencies[start_index : end_index + 1]
+
+    return Spectrogram(
+        transformed_dynamic_spectra,
+        spectrogram.times,
+        transformed_frequencies,
+        spectrogram.tag,
+        spectrogram.spectrum_unit,
+        spectrogram.start_datetime,
+    )
 
 
 def time_chop(
-    spectrogram: Spectrogram, 
-    start_datetime: datetime, 
-    end_datetime: datetime
+    spectrogram: Spectrogram, start_datetime: datetime, end_datetime: datetime
 ) -> Spectrogram:
     """
     Extracts a portion of the spectrogram within the specified time range.
@@ -72,45 +85,57 @@ def time_chop(
     :return: A new spectrogram containing only the specified time range.
     """
     start_datetime64 = np.datetime64(start_datetime)
-    end_datetime64   = np.datetime64(end_datetime)
+    end_datetime64 = np.datetime64(end_datetime)
 
-    is_entirely_below_time_range = (start_datetime64 < spectrogram.datetimes[0] and end_datetime64 < spectrogram.datetimes[0])
-    is_entirely_above_time_range = (start_datetime64 > spectrogram.datetimes[-1] and end_datetime64 > spectrogram.datetimes[-1])
+    is_entirely_below_time_range = (
+        start_datetime64 < spectrogram.datetimes[0]
+        and end_datetime64 < spectrogram.datetimes[0]
+    )
+    is_entirely_above_time_range = (
+        start_datetime64 > spectrogram.datetimes[-1]
+        and end_datetime64 > spectrogram.datetimes[-1]
+    )
     if is_entirely_below_time_range or is_entirely_above_time_range:
-        raise ValueError(f"Requested time interval is entirely out of range of the input spectrogram.")
-    
+        raise ValueError(
+            f"Requested time interval is entirely out of range of the input spectrogram."
+        )
+
     # find the index of the nearest matching spectrums in the spectrogram.
     start_index = find_closest_index(start_datetime64, spectrogram.datetimes)
-    end_index   = find_closest_index(end_datetime64, spectrogram.datetimes)
-    
+    end_index = find_closest_index(end_datetime64, spectrogram.datetimes)
+
     # enforce distinct start and end indices
     if start_index == end_index:
-        raise ValueError(f"Start and end indices are equal! Got start_index: {start_index} and end_index: {end_index}")
-    
+        raise ValueError(
+            f"Start and end indices are equal! Got start_index: {start_index} and end_index: {end_index}"
+        )
+
     # if start index is more than end index, swap the ordering so to enforce start_index <= end_index
     if start_index > end_index:
         start_index, end_index = end_index, start_index
 
     # chop the spectrogram accordingly
-    transformed_dynamic_spectra = spectrogram.dynamic_spectra[:, start_index:end_index+1]
+    transformed_dynamic_spectra = spectrogram.dynamic_spectra[
+        :, start_index : end_index + 1
+    ]
     transformed_start_datetime = spectrogram.datetimes[start_index]
 
     # chop the times array and translate such that the first spectrum to t=0 [s]
-    transformed_times  = spectrogram.times[start_index:end_index+1]
+    transformed_times = spectrogram.times[start_index : end_index + 1]
     transformed_times -= transformed_times[0]
 
-    return Spectrogram(transformed_dynamic_spectra, 
-                       transformed_times, 
-                       spectrogram.frequencies, 
-                       spectrogram.tag, 
-                       spectrogram.spectrum_unit,
-                       transformed_start_datetime)
+    return Spectrogram(
+        transformed_dynamic_spectra,
+        transformed_times,
+        spectrogram.frequencies,
+        spectrogram.tag,
+        spectrogram.spectrum_unit,
+        transformed_start_datetime,
+    )
 
 
 def _validate_and_compute_average_over(
-    original_resolution: float,
-    resolution: Optional[float], 
-    average_over: int
+    original_resolution: float, resolution: Optional[float], average_over: int
 ) -> int:
     """
     Validates the input parameters and computes `average_over` if `resolution` is specified.
@@ -125,7 +150,9 @@ def _validate_and_compute_average_over(
         return average_over
 
     if not (resolution is not None) ^ (average_over != 1):
-        raise ValueError("Exactly one of 'resolution' or 'average_over' must be specified.")
+        raise ValueError(
+            "Exactly one of 'resolution' or 'average_over' must be specified."
+        )
 
     if resolution is not None:
         return max(1, floor(resolution / original_resolution))
@@ -155,9 +182,7 @@ def time_average(
         )
 
     average_over = _validate_and_compute_average_over(
-        spectrogram.time_resolution,
-        resolution, 
-        average_over
+        spectrogram.time_resolution, resolution, average_over
     )
 
     # Perform averaging
@@ -167,9 +192,9 @@ def time_average(
     transformed_times = average_array(spectrogram.times, average_over)
 
     # Update start datetime and adjust times to start at t=0
-    transformed_start_datetime = (
-        spectrogram.datetimes[0] + (transformed_times[0]*1e6).astype("timedelta64[us]")
-    )
+    transformed_start_datetime = spectrogram.datetimes[0] + (
+        transformed_times[0] * 1e6
+    ).astype("timedelta64[us]")
     transformed_times -= transformed_times[0]
 
     return Spectrogram(
@@ -197,9 +222,7 @@ def frequency_average(
     :return: A new spectrogram with frequency-averaged data.
     """
     average_over = _validate_and_compute_average_over(
-        spectrogram.frequency_resolution,
-        resolution, 
-        average_over
+        spectrogram.frequency_resolution, resolution, average_over
     )
 
     # Perform averaging
@@ -218,9 +241,7 @@ def frequency_average(
     )
 
 
-def join_spectrograms(
-    spectrograms: list[Spectrogram]
-) -> Spectrogram:
+def join_spectrograms(spectrograms: list[Spectrogram]) -> Spectrogram:
     """
     Joins multiple spectrograms into a single spectrogram along the time axis.
 
@@ -236,30 +257,42 @@ def join_spectrograms(
     num_spectrograms = len(spectrograms)
     if num_spectrograms == 0:
         raise ValueError(f"Input list of spectrograms is empty!")
-    
+
     # extract the first element of the list, and use this as a reference for comparison
     # input validations.
-    reference_spectrogram = spectrograms[0] 
+    reference_spectrogram = spectrograms[0]
 
     # perform checks on each spectrogram in teh list
     for spectrogram in spectrograms:
-        if not np.all(np.equal(spectrogram.frequencies, reference_spectrogram.frequencies)):
+        if not np.all(
+            np.equal(spectrogram.frequencies, reference_spectrogram.frequencies)
+        ):
             raise ValueError(f"All spectrograms must have identical frequency ranges")
         if spectrogram.tag != reference_spectrogram.tag:
-            raise ValueError(f"All tags must be equal for each spectrogram in the input list!")
+            raise ValueError(
+                f"All tags must be equal for each spectrogram in the input list!"
+            )
         if spectrogram.spectrum_unit != reference_spectrogram.spectrum_unit:
-            raise ValueError(f"All units must be equal for each spectrogram in the input list!")
+            raise ValueError(
+                f"All units must be equal for each spectrogram in the input list!"
+            )
         if not spectrogram.start_datetime_is_set:
             raise ValueError(f"All spectrograms must have their start datetime set.")
 
     # Concatenate all dynamic spectra directly along the time axis
-    transformed_dynamic_spectra = np.hstack([spectrogram.dynamic_spectra for spectrogram in spectrograms])
-    
-    transformed_times = time_elapsed( np.concatenate([s.datetimes for s in spectrograms]) )
-
-    return Spectrogram(transformed_dynamic_spectra, 
-                       transformed_times, 
-                       reference_spectrogram.frequencies, 
-                       reference_spectrogram.tag, 
-                       reference_spectrogram.spectrum_unit,
-                       reference_spectrogram.start_datetime) 
+    transformed_dynamic_spectra = np.hstack(
+        [spectrogram.dynamic_spectra for spectrogram in spectrograms]
+    )
+
+    transformed_times = time_elapsed(
+        np.concatenate([s.datetimes for s in spectrograms])
+    )
+
+    return Spectrogram(
+        transformed_dynamic_spectra,
+        transformed_times,
+        reference_spectrogram.frequencies,
+        reference_spectrogram.tag,
+        reference_spectrogram.spectrum_unit,
+        reference_spectrogram.start_datetime,
+    )

spectre_core/wgetting/__init__.py

@@ -6,6 +6,4 @@
 
 from ._callisto import download_callisto_data, CallistoInstrumentCode
 
-__all__ = [
-    "download_callisto_data", "CallistoInstrumentCode"
-]
+__all__ = ["download_callisto_data", "CallistoInstrumentCode"]

spectre_core/wgetting/_callisto.py

@@ -10,74 +10,73 @@ from datetime import datetime, date
 from typing import Tuple
 
 from spectre_core.config import (
-    get_spectre_data_dir_path, get_batches_dir_path, TimeFormat
+    get_spectre_data_dir_path,
+    get_batches_dir_path,
+    TimeFormat,
 )
 
 from enum import Enum
 
+
 class CallistoInstrumentCode(Enum):
     """e-Callisto network station codes."""
-    ALASKA_ANCHORAGE     = "ALASKA-ANCHORAGE"
-    ALASKA_COHOE         = "ALASKA-COHOE"
-    ALASKA_HAARP         = "ALASKA-HAARP"
-    ALGERIA_CRAAG        = "ALGERIA-CRAAG"
-    ALMATY               = "ALMATY"
-    AUSTRIA_KRUMBACH     = "AUSTRIA-Krumbach"
-    AUSTRIA_MICHELBACH   = "AUSTRIA-MICHELBACH"
-    AUSTRIA_OE3FLB       = "AUSTRIA-OE3FLB"
-    AUSTRIA_UNIGRAZ      = "AUSTRIA-UNIGRAZ"
-    AUSTRALIA_ASSA       = "Australia-ASSA"
-    BIR                  = "BIR"
-    CROATIA_VISNJAN      = "Croatia-Visnjan"
-    DENMARK              = "DENMARK"
-    EGYPT_ALEXANDRIA     = "EGYPT-Alexandria"
-    EGYPT_SPACEAGENCY    = "EGYPT-SpaceAgency"
-    FINLAND_SIUNTIO      = "FINLAND-Siuntio"
-    FINLAND_KEMPELE      = "Finland-Kempele"
-    GERMANY_DLR          = "GERMANY-DLR"
-    GLASGOW              = "GLASGOW"
-    GREENLAND            = "GREENLAND"
-    HUMAIN               = "HUMAIN"
-    HURBANOVO            = "HURBANOVO"
-    INDIA_GAURI          = "INDIA-GAURI"
-    INDIA_OOTY           = "INDIA-OOTY"
-    INDIA_UDAIPUR        = "INDIA-UDAIPUR"
-    JAPAN_IBARAKI        = "JAPAN-IBARAKI"
-    KASI                 = "KASI"
-    MEXART               = "MEXART"
-    MEXICO_FCFM_UANL     = "MEXICO-FCFM-UANL"
-    MEXICO_LANCE_A       = "MEXICO-LANCE-A"
-    MEXICO_LANCE_B       = "MEXICO-LANCE-B"
-    MONGOLIA_UB          = "MONGOLIA-UB"
-    MRO                  = "MRO"
-    MRT3                 = "MRT3"
-    MALAYSIA_BANTING     = "Malaysia-Banting"
-    NORWAY_EGERSUND      = "NORWAY-EGERSUND"
-    NORWAY_NY_AALESUND   = "NORWAY-NY-AALESUND"
-    NORWAY_RANDABERG     = "NORWAY-RANDABERG"
-    POLAND_GROTNIKI      = "POLAND-Grotniki"
-    ROMANIA              = "ROMANIA"
-    ROSWELL_NM           = "ROSWELL-NM"
-    SPAIN_PERALEJOS      = "SPAIN-PERALEJOS"
-    SSRT                 = "SSRT"
-    SWISS_HB9SCT         = "SWISS-HB9SCT"
-    SWISS_HEITERSWIL     = "SWISS-HEITERSWIL"
-    SWISS_IRSOL          = "SWISS-IRSOL"
-    SWISS_LANDSCHLACHT   = "SWISS-Landschlacht"
-    SWISS_MUHEN          = "SWISS-MUHEN"
-    TRIEST               = "TRIEST"
-    TURKEY               = "TURKEY"
-    UNAM                 = "UNAM"
-    URUGUAY              = "URUGUAY"
-    USA_BOSTON           = "USA-BOSTON"
-
-
-def _get_batch_name(
-    station: str, 
-    date: str, 
-    time: str, 
-    code: str
-) -> str:
+
+    ALASKA_ANCHORAGE = "ALASKA-ANCHORAGE"
+    ALASKA_COHOE = "ALASKA-COHOE"
+    ALASKA_HAARP = "ALASKA-HAARP"
+    ALGERIA_CRAAG = "ALGERIA-CRAAG"
+    ALMATY = "ALMATY"
+    AUSTRIA_KRUMBACH = "AUSTRIA-Krumbach"
+    AUSTRIA_MICHELBACH = "AUSTRIA-MICHELBACH"
+    AUSTRIA_OE3FLB = "AUSTRIA-OE3FLB"
+    AUSTRIA_UNIGRAZ = "AUSTRIA-UNIGRAZ"
+    AUSTRALIA_ASSA = "Australia-ASSA"
+    BIR = "BIR"
+    CROATIA_VISNJAN = "Croatia-Visnjan"
+    DENMARK = "DENMARK"
+    EGYPT_ALEXANDRIA = "EGYPT-Alexandria"
+    EGYPT_SPACEAGENCY = "EGYPT-SpaceAgency"
+    FINLAND_SIUNTIO = "FINLAND-Siuntio"
+    FINLAND_KEMPELE = "Finland-Kempele"
+    GERMANY_DLR = "GERMANY-DLR"
+    GLASGOW = "GLASGOW"
+    GREENLAND = "GREENLAND"
+    HUMAIN = "HUMAIN"
+    HURBANOVO = "HURBANOVO"
+    INDIA_GAURI = "INDIA-GAURI"
+    INDIA_OOTY = "INDIA-OOTY"
+    INDIA_UDAIPUR = "INDIA-UDAIPUR"
+    JAPAN_IBARAKI = "JAPAN-IBARAKI"
+    KASI = "KASI"
+    MEXART = "MEXART"
+    MEXICO_FCFM_UANL = "MEXICO-FCFM-UANL"
+    MEXICO_LANCE_A = "MEXICO-LANCE-A"
+    MEXICO_LANCE_B = "MEXICO-LANCE-B"
+    MONGOLIA_UB = "MONGOLIA-UB"
+    MRO = "MRO"
+    MRT3 = "MRT3"
+    MALAYSIA_BANTING = "Malaysia-Banting"
+    NORWAY_EGERSUND = "NORWAY-EGERSUND"
+    NORWAY_NY_AALESUND = "NORWAY-NY-AALESUND"
+    NORWAY_RANDABERG = "NORWAY-RANDABERG"
+    POLAND_GROTNIKI = "POLAND-Grotniki"
+    ROMANIA = "ROMANIA"
+    ROSWELL_NM = "ROSWELL-NM"
+    SPAIN_PERALEJOS = "SPAIN-PERALEJOS"
+    SSRT = "SSRT"
+    SWISS_HB9SCT = "SWISS-HB9SCT"
+    SWISS_HEITERSWIL = "SWISS-HEITERSWIL"
+    SWISS_IRSOL = "SWISS-IRSOL"
+    SWISS_LANDSCHLACHT = "SWISS-Landschlacht"
+    SWISS_MUHEN = "SWISS-MUHEN"
+    TRIEST = "TRIEST"
+    TURKEY = "TURKEY"
+    UNAM = "UNAM"
+    URUGUAY = "URUGUAY"
+    USA_BOSTON = "USA-BOSTON"
+
+
+def _get_batch_name(station: str, date: str, time: str, code: str) -> str:
     """
     Create a standardised batch file name for a `spectre` batch file.
 
@@ -92,9 +91,7 @@ def _get_batch_name(
     return f"{formatted_time}_callisto-{station.lower()}-{code}.fits"
 
 
-def _get_batch_components(
-    gz_path: str
-) -> list[str]:
+def _get_batch_components(gz_path: str) -> list[str]:
     """
     Extract station, date, time, and instrument code from the `.fit.gz` file name.
 
@@ -106,15 +103,15 @@ def _get_batch_components(
     if not file_name.endswith(".fit.gz"):
         raise ValueError(f"Invalid file extension: {file_name}. Expected .fit.gz")
     file_base_name = file_name.rstrip(".fit.gz")
-    parts = file_base_name.split('_')
+    parts = file_base_name.split("_")
     if len(parts) != 4:
-        raise ValueError("Invalid file name format. Expected '[station]_[date]_[time]_[code].fit.gz'")
+        raise ValueError(
+            "Invalid file name format. Expected '[station]_[date]_[time]_[code].fit.gz'"
+        )
     return parts
 
 
-def _get_batch_path(
-    gz_path: str
-) -> str:
+def _get_batch_path(gz_path: str) -> str:
     """
     Generate the full path for the `spectre` batch file.
 
@@ -130,9 +127,7 @@ def _get_batch_path(
     return os.path.join(batch_dir, batch_name)
 
 
-def _unzip_file_to_batches(
-    gz_path: str
-) -> str:
+def _unzip_file_to_batches(gz_path: str) -> str:
     """
     Decompress a `.fit.gz` file and save it as a `.fits` batch file.
 
@@ -145,9 +140,7 @@ def _unzip_file_to_batches(
         return f_out.name
 
 
-def _unzip_to_batches(
-    tmp_dir: str
-) -> list[str]:
+def _unzip_to_batches(tmp_dir: str) -> list[str]:
     """
     Decompress all `.gz` files in a temporary directory and save them as `spectre`
     batch files.
@@ -158,19 +151,14 @@ def _unzip_to_batches(
     batch_file_names = []
     for entry in os.scandir(tmp_dir):
         if entry.is_file() and entry.name.endswith(".gz"):
-            batch_file_names.append( _unzip_file_to_batches(entry.path) )
+            batch_file_names.append(_unzip_file_to_batches(entry.path))
             os.remove(entry.path)
     shutil.rmtree(tmp_dir)
     return batch_file_names
-            
 
 
 def _wget_callisto_data(
-    instrument_code: str, 
-    year: int, 
-    month: int, 
-    day: int, 
-    tmp_dir: str
+    instrument_code: str, year: int, month: int, day: int, tmp_dir: str
 ) -> None:
     """
     Download raw `.fit.gz` files from the e-Callisto network using `wget`.
@@ -184,18 +172,24 @@ def _wget_callisto_data(
     date_str = f"{year:04d}/{month:02d}/{day:02d}"
     base_url = f"http://soleil.i4ds.ch/solarradio/data/2002-20yy_Callisto/{date_str}/"
     command = [
-        "wget", "-r", "-l1", "-nd", "-np",
-        "-R", ".tmp", "-A", f"{instrument_code}*.fit.gz",
-        "-P", tmp_dir, base_url
+        "wget",
+        "-r",
+        "-l1",
+        "-nd",
+        "-np",
+        "-R",
+        ".tmp",
+        "-A",
+        f"{instrument_code}*.fit.gz",
+        "-P",
+        tmp_dir,
+        base_url,
     ]
     subprocess.run(command, check=True)
 
 
 def download_callisto_data(
-    instrument_code: CallistoInstrumentCode, 
-    year: int, 
-    month: int, 
-    day: int
+    instrument_code: CallistoInstrumentCode, year: int, month: int, day: int
 ) -> Tuple[list[str], date]:
     """
     Download and decompress e-Callisto FITS files, saving them as `spectre` batch files.
@@ -204,13 +198,13 @@ def download_callisto_data(
     :param year: Year of the observation.
     :param month: Month of the observation.
     :param day: Day of the observation.
-    :return: A list of file names of all newly created batch files, as absolute paths within the container's file system. Additionally, return the start date shared by all batch files. 
+    :return: A list of file names of all newly created batch files, as absolute paths within the container's file system. Additionally, return the start date shared by all batch files.
     """
     tmp_dir = os.path.join(get_spectre_data_dir_path(), "tmp")
     # if there are any residual files in the temporary directory, remove them.
     if os.path.exists(tmp_dir):
         shutil.rmtree(tmp_dir)
     os.makedirs(tmp_dir, exist_ok=True)
-    
+
     _wget_callisto_data(instrument_code.value, year, month, day, tmp_dir)
-    return sorted( _unzip_to_batches(tmp_dir) ), date(year, month, day)
+    return sorted(_unzip_to_batches(tmp_dir)), date(year, month, day)

{spectre_core-0.0.22.dist-info → spectre_core-0.0.23.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spectre-core
-Version: 0.0.22
+Version: 0.0.23
 Summary: The core Python package used by the spectre program. 
 Maintainer-email: Jimmy Fitzpatrick <jcfitzpatrick12@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -691,33 +691,19 @@ Requires-Dist: scipy==1.12.0
 Requires-Dist: astropy==6.0.1
 Requires-Dist: matplotlib==3.5.0
 Requires-Dist: watchdog==4.0.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: mypy; extra == "test"
+Requires-Dist: black; extra == "test"
 Dynamic: license-file
 
 # spectre-core
 
 ## Description
-  
-:loudspeaker: **This project is under active development. Contributors welcome.** :loudspeaker:  
-
-```spectre-core``` provides an extensible, receiver-agnostic toolkit for generating radio spectrograms in real-time. It is the core Python package used by the [`spectre`](https://github.com/jcfitzpatrick12/spectre.git) program.   
-
-
-## Installation
-Simply call:  
-```bash
-pip install spectre-core
-```
-
-Alternatively, you can clone the repository in your preferred directory:  
-```bash
-git clone https://github.com/jcfitzpatrick12/spectre-core.git && cd spectre-core
-```  
-
-Then run:  
-```
-pip install -e .
-```
+A receiver-agnostic toolkit for generating radio spectrograms in real-time. Contains server-side implementations for [_Spectre_](https://github.com/jcfitzpatrick12/spectre.git).
 
+**⚠️ Note:**  
+This repository is not intended for direct consumption.
 
 ## Contributing
-This repository is in active development. If you are interested, feel free to contact  jcfitzpatrick12@gmail.com :)
+If you'd like to raise an issue, or want to make a change, please refer to the _Contributing_ section in the [README](https://github.com/jcfitzpatrick12/spectre/blob/main/README.md) for _Spectre_.