GSOC: add from hdf method to spectrum class

.mailmap

@@ -119,6 +119,8 @@ Josh Shields <[email protected]>
 Karan Desai <[email protected]>
 Karan Desai <[email protected]> karandesai-96 <[email protected]>
 
+Karthik Rishinarada <[email protected]>
+
 Kaushik Varanasi <[email protected]>
 Kaushik Varanasi <[email protected]> kaushik94 <[email protected]>
 

docs/physics/spectrum/basic.ipynb

@@ -417,6 +417,35 @@
     "spectrum.plot(mode='wavelength')"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "4a34a1ba",
+   "metadata": {},
+   "source": [
+    "Inorder to retrieve your Spectrum class from an hdf file, follow the below steps"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "abef6bb1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "spectrum.to_hdf(\"test.hdf\", overwrite=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "2eb89482",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "obj = spectrum.from_hdf_to_class(\"test.hdf\")\n",
+    "print(obj._frequency == spectrum._frequency)\n"
+   ]
+  },
   {
    "attachments": {},
    "cell_type": "markdown",
@@ -460,7 +489,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.3"
+   "version": "3.12.0"
   }
  },
  "nbformat": 4,

tardis/spectrum/spectrum.py

@@ -1,6 +1,7 @@
 import warnings
 
 import numpy as np
+import pandas as pd
 from astropy import units as u
 
 from tardis.io.util import HDFWriterMixin
@@ -151,6 +152,20 @@ def plot(self, ax=None, mode="wavelength", **kwargs):
         else:
             warnings.warn(f"Did not find plotting mode {mode}, doing nothing.")
 
+    def from_hdf_to_class(self,hdf_path):
+        try:
+            with pd.HDFStore(hdf_path, mode="r") as store:
+                _freq = store['/tardis_spectrum/_frequency']
+                _f = np.array(_freq) * u.Hz
+
+                _lumi = store['/tardis_spectrum/luminosity']
+                _l = np.array(_lumi) * (u.erg/u.s)
+
+                return TARDISSpectrum(_f, _l)
+
+        except FileNotFoundError as e:
+            print(f"File not found: {e}")
+
     def to_ascii(self, fname, mode="luminosity_density"):
         if mode == "luminosity_density":
             np.savetxt(

tardis/spectrum/tests/test_spectrum.py

@@ -135,6 +135,14 @@ def test_f_nu_to_f_lambda(spectrum):
         spectrum.luminosity_density_lambda.value, expected.value
     )
 
+
+def test_from_hdf_to_class(spectrum):
+    actual = TARDISSpectrum(spectrum._frequency, spectrum.luminosity)
+    actual.to_hdf("test.hdf", overwrite=True)
+    expected = actual.from_hdf_to_class("test.hdf")
+
+    compare_spectra(actual, expected)
+
 
 ###
 # Save and Load