spectre-core 0.0.16__tar.gz → 0.0.18__tar.gz

{spectre_core-0.0.16 → spectre_core-0.0.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: spectre-core
-Version: 0.0.16
+Version: 0.0.18
 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.16 → spectre_core-0.0.18}/pyproject.toml

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

{spectre_core-0.0.16 → spectre_core-0.0.18}/src/spectre_core/config/__init__.py

@@ -6,7 +6,8 @@
 """General `spectre` package configurations."""
 
 from ._paths import (
-    get_spectre_data_dir_path, get_batches_dir_path, get_configs_dir_path, get_logs_dir_path
+    get_spectre_data_dir_path, get_batches_dir_path, get_configs_dir_path, 
+    get_logs_dir_path, trim_spectre_data_dir_path
 )
 from ._time_formats import (
     TimeFormat
@@ -14,5 +15,5 @@ from ._time_formats import (
 
 __all__ = [
     "get_spectre_data_dir_path", "get_batches_dir_path", "get_configs_dir_path", "get_logs_dir_path",
-    "TimeFormat"
+    "TimeFormat", "trim_spectre_data_dir_path"
 ]

{spectre_core-0.0.16 → spectre_core-0.0.18}/src/spectre_core/config/_paths.py

@@ -115,3 +115,35 @@ def get_configs_dir_path(
     :return: The directory path for configuration files.
     """
     return _CONFIGS_DIR_PATH
+
+
+def trim_spectre_data_dir_path(
+    full_path: str
+) -> str:
+    """Remove the `SPECTRE_DATA_DIR_PATH` prefix from a full file path.
+
+    This function returns the relative path of `full_path` with respect to
+    `SPECTRE_DATA_DIR_PATH`. It is useful for trimming absolute paths
+    to maintain consistency across different environments where the base
+    directory might differ.
+
+    :param full_path: The full file path to be trimmed.
+    :return: The relative path with `SPECTRE_DATA_DIR_PATH` removed.
+    """
+    return os.path.relpath(full_path, _SPECTRE_DATA_DIR_PATH)
+
+
+def add_spectre_data_dir_path(
+    rel_path: str
+) -> str:
+    """Prepend the `SPECTRE_DATA_DIR_PATH` prefix to a relative file path.
+
+    This function constructs an absolute path by joining the given relative
+    path with `SPECTRE_DATA_DIR_PATH`. It is useful for converting stored
+    relative paths back into full paths within the mounted directory.
+
+    :param rel_path: The relative file path to be appended.
+    :return: The full file path prefixed with `SPECTRE_DATA_DIR_PATH`.
+    """
+    return os.path.join(_SPECTRE_DATA_DIR_PATH, rel_path)
+

{spectre_core-0.0.16 → spectre_core-0.0.18}/src/spectre_core/wgetting/_callisto.py

@@ -8,7 +8,9 @@ import shutil
 import gzip
 from datetime import datetime
 
-from spectre_core.config import get_spectre_data_dir_path, get_batches_dir_path, TimeFormat
+from spectre_core.config import (
+    get_spectre_data_dir_path, get_batches_dir_path, TimeFormat, trim_spectre_data_dir_path
+)
 
 from enum import Enum
 
@@ -129,30 +131,37 @@ def _get_batch_path(
 
 def _unzip_file_to_batches(
     gz_path: str
-) -> None:
+) -> str:
     """
     Decompress a `.fit.gz` file and save it as a `.fits` batch file.
 
     :param gz_path: Path to the `.fit.gz` file.
+    :return: The file path of the newly created batch file, relative to `SPECTRE_DATA_DIR_PATH`.
     """
     fits_path = _get_batch_path(gz_path)
     with gzip.open(gz_path, "rb") as f_in, open(fits_path, "wb") as f_out:
         shutil.copyfileobj(f_in, f_out)
+        return trim_spectre_data_dir_path(f_out.name)
 
 
 def _unzip_to_batches(
     tmp_dir: str
-) -> None:
+) -> list[str]:
     """
     Decompress all `.gz` files in a temporary directory and save them as `spectre`
     batch files.
 
     :param tmp_dir: Path to the temporary directory containing `.gz` files.
+    :return: A list of file names of all newly created batch files, relative to `SPECTRE_DATA_DIR_PATH`.
     """
+    batch_file_names = []
     for entry in os.scandir(tmp_dir):
         if entry.is_file() and entry.name.endswith(".gz"):
-            _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(
@@ -186,7 +195,7 @@ def download_callisto_data(
     year: int, 
     month: int, 
     day: int
-) -> None:
+) -> list[str]:
     """
     Download and decompress e-Callisto FITS files, saving them as `spectre` batch files.
 
@@ -194,6 +203,7 @@ 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, relative to `SPECTRE_DATA_DIR_PATH`.
     """
     tmp_dir = os.path.join(get_spectre_data_dir_path(), "tmp")
     # if there are any residual files in the temporary directory, remove them.
@@ -202,5 +212,4 @@ def download_callisto_data(
     os.makedirs(tmp_dir, exist_ok=True)
     
     _wget_callisto_data(instrument_code.value, year, month, day, tmp_dir)
-    _unzip_to_batches(tmp_dir)
-    shutil.rmtree(tmp_dir)
+    return sorted( _unzip_to_batches(tmp_dir) )

{spectre_core-0.0.16 → spectre_core-0.0.18}/src/spectre_core.egg-info/PKG-INFO

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