lisaanalysistools 1.0.1__cp312-cp312-macosx_10_9_x86_64.whl → 1.0.3__cp312-cp312-macosx_10_9_x86_64.whl

{lisaanalysistools-1.0.1.dist-info → lisaanalysistools-1.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lisaanalysistools
-Version: 1.0.1
+Version: 1.0.3
 Home-page: https://github.com/mikekatz04/lisa-on-gpu
 Author: Michael Katz
 Author-email: mikekatz04@gmail.com
@@ -59,7 +59,7 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduc
 
 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/BlackHolePerturbationToolkit/FastEMRIWaveforms/tags).
 
-Current Version: 1.0.1
+Current Version: 1.0.3
 
 ## Authors/Developers
 

{lisaanalysistools-1.0.1.dist-info → lisaanalysistools-1.0.3.dist-info}/RECORD

@@ -1,13 +1,13 @@
 lisatools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-lisatools/_version.py,sha256=1jFk9o0EEGpBLxDSAAHpzrzFxfly0qjljEoqarE0STI,123
-lisatools/analysiscontainer.py,sha256=KG1Iww3iYHyeoKYgfASqQ2Lu2VilXuW9zDW1Jkw5ARc,15329
+lisatools/_version.py,sha256=jdUA4C9ymxkLy21lzpy24-UicUen9JG4Nd2NN9PTeuc,123
+lisatools/analysiscontainer.py,sha256=7IV5Ddd9sP5uLenEDmitmrSG7GhUzVojs41XAgJSwVg,15333
 lisatools/datacontainer.py,sha256=MErM0cWZdxVtbaA8HTU79bXmxv2XcYDcqPiHyPbPZE0,9224
-lisatools/detector.py,sha256=YGia0eoeftXDxIJXDsC8MsfRm_Z1xwUG2r-qZ6lNvOs,12163
+lisatools/detector.py,sha256=Ht5v-Iq_DJlCWMt9iSbZwmEwTGwd3pdeOaw4lBtmiBQ,13852
 lisatools/diagnostic.py,sha256=oPMovelkyTYUXQWzLvtZB-nia-oxYhlNIci4P2r0Bhg,34177
 lisatools/glitch.py,sha256=qMNSqdmGqdm6kVtZP9qncP_40DyPj9ushbXh88g9wlU,5154
 lisatools/sensitivity.py,sha256=4ELRfrB5CY7Fkg6LYuuseTdbqnx59My0i7cGvK2VxKg,27236
 lisatools/stochastic.py,sha256=XYZpsWiVB8Yz9V5-_hAKjzOfqe8e5ln0amtWypjqCCg,9440
-lisatools/cutils/detector.cpython-312-darwin.so,sha256=THx-1ysBWhHf54vU10ZyBpQN-38ON7F7IE74FTwvatQ,121664
+lisatools/cutils/detector.cpython-312-darwin.so,sha256=FguczB3QPZfL3CCSMEuIx3VP0jj240_Dh30anER84m8,121664
 lisatools/sampling/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 lisatools/sampling/likelihood.py,sha256=G2kAQ43qlhAzIFWvYsrSmHXd7WKJAzcCN2o07vRE8vc,29585
 lisatools/sampling/prior.py,sha256=V9sWorxDamgsSFPZpK3t1651yPp6znRVXe0zto0wFpc,18461
@@ -30,8 +30,8 @@ lisatools/utils/constants.py,sha256=r1kVwkpbZS13JTOxj2iRxT5sMgTYX30y-S0JdVmD5Oo,
 lisatools/utils/multigpudataholder.py,sha256=6HwkOceqga1Q7eK4TjStGXy4oKgx37hTkdcAwiiZ8_Y,33765
 lisatools/utils/pointeradjust.py,sha256=2sT-7qeYWr1pd_sHk9leVHUTSJ7jJgYIRoWQOtYqguE,2995
 lisatools/utils/utility.py,sha256=TgZ4vLVGih4ZU2caMRlK06m8nMoEVvwrS3Q7dH83u1g,6742
-lisaanalysistools-1.0.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-lisaanalysistools-1.0.1.dist-info/METADATA,sha256=vc9LlEpkF1ewaHP-pMHaWCHHzdqKTfo8W3IL4taqrd8,2753
-lisaanalysistools-1.0.1.dist-info/WHEEL,sha256=KYtn_mzb_QwZSHwPlosUO3fDl70znfUFngLlrLVHeBY,111
-lisaanalysistools-1.0.1.dist-info/top_level.txt,sha256=oCQGY7qy66i_b9MCsK2fTRdbV1pcC9GsGgIDjN47Tyc,14
-lisaanalysistools-1.0.1.dist-info/RECORD,,
+lisaanalysistools-1.0.3.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+lisaanalysistools-1.0.3.dist-info/METADATA,sha256=jHsBjQZRdfnN72tM9B83NDwk5xtmKGs3epn7bzL6jZk,2753
+lisaanalysistools-1.0.3.dist-info/WHEEL,sha256=KYtn_mzb_QwZSHwPlosUO3fDl70znfUFngLlrLVHeBY,111
+lisaanalysistools-1.0.3.dist-info/top_level.txt,sha256=oCQGY7qy66i_b9MCsK2fTRdbV1pcC9GsGgIDjN47Tyc,14
+lisaanalysistools-1.0.3.dist-info/RECORD,,

lisatools/_version.py

@@ -1,4 +1,4 @@
-__version__ = '1.0.1'
+__version__ = '1.0.3'
 __copyright__ = "Michael L. Katz 2024"
 __name__ = "lisaanalysistools"
 __author__ = "Michael L. Katz"

lisatools/analysiscontainer.py

@@ -268,7 +268,7 @@ class AnalysisContainer:
             return noise_likelihood_term(self.sens_mat)
         elif source_only:
             return residual_source_likelihood_term(
-                self.data_res_arr, self.sens_mat, **kwargs
+                self.data_res_arr, psd=self.sens_mat, **kwargs
             )
         else:
             return residual_full_source_and_noise_likelihood(

lisatools/detector.py

@@ -22,7 +22,6 @@ class Orbits(ABC):
     Args:
         filename: File name. File should be in the style of LISAOrbits
 
-
     """
 
     def __init__(self, filename: str) -> None:
@@ -51,6 +50,7 @@ class Orbits(ABC):
         return [int(str(link_i)[1]) for link_i in self.LINKS]
 
     def _setup(self) -> None:
+        """Read in orbital data from file and store."""
         with self.open() as f:
             for key in f.attrs.keys():
                 setattr(self, key + "_base", f.attrs[key])
@@ -63,22 +63,33 @@ class Orbits(ABC):
     @filename.setter
     def filename(self, filename: str) -> None:
         """Set file name."""
+
         assert isinstance(filename, str)
+
+        # get path
         path_to_this_file = __file__.split("detector.py")[0]
+
+        # make sure orbit_files directory exists in the right place
         if not os.path.exists(path_to_this_file + "orbit_files/"):
             os.mkdir(path_to_this_file + "orbit_files/")
         path_to_this_file = path_to_this_file + "orbit_files/"
+
         if not os.path.exists(path_to_this_file + filename):
-            github_file = f"https://github.com/mikekatz04/LISAanalysistools/raw/main/orbit_files/{filename}"
+            # download files from github if they are not there
+            github_file = f"https://github.com/mikekatz04/LISAanalysistools/raw/main/lisatools/orbit_files/{filename}"
             r = requests.get(github_file)
+
+            # if not success
             if r.status_code != 200:
                 raise ValueError(
-                    f"Cannot find {filename} within default files located at github.com/mikekatz04/LISAanalysistools/orbit_files/."
+                    f"Cannot find {filename} within default files located at github.com/mikekatz04/LISAanalysistools/lisatools/orbit_files/."
                 )
 
+            # write the contents to a local file
             with open(path_to_this_file + filename, "wb") as f:
                 f.write(r.content)
 
+        # store
         self._filename = path_to_this_file + filename
 
     def open(self) -> h5py.File:
@@ -96,7 +107,7 @@ class Orbits(ABC):
 
     @property
     def t_base(self) -> np.ndarray:
-        """Light travel times along links from file."""
+        """Time array from file."""
         with self.open() as f:
             t_base = np.arange(self.size_base) * self.dt_base
         return t_base
@@ -117,14 +128,14 @@ class Orbits(ABC):
 
     @property
     def x_base(self) -> np.ndarray:
-        """Light travel times along links from file."""
+        """Spacecraft position from file."""
         with self.open() as f:
             x = f["tcb"]["x"][:]
         return x
 
     @property
     def v_base(self) -> np.ndarray:
-        """Light travel times along links from file."""
+        """Spacecraft velocities from file."""
         with self.open() as f:
             v = f["tcb"]["v"][:]
         return v
@@ -154,35 +165,35 @@ class Orbits(ABC):
 
     @property
     def n(self) -> np.ndarray:
-        """Light travel time."""
+        """Normal vectors along links."""
         self._check_configured()
         return self._n
 
     @n.setter
     def n(self, n: np.ndarray) -> np.ndarray:
-        """Set light travel time."""
+        """Set Normal vectors along links."""
         return self._n
 
     @property
     def x(self) -> np.ndarray:
-        """Light travel time."""
+        """Spacecraft positions."""
         self._check_configured()
         return self._x
 
     @x.setter
     def x(self, x: np.ndarray) -> np.ndarray:
-        """Set light travel time."""
+        """Set Spacecraft positions."""
         return self._x
 
     @property
     def v(self) -> np.ndarray:
-        """Light travel time."""
+        """Spacecraft velocities."""
         self._check_configured()
         return self._v
 
     @v.setter
     def v(self, v: np.ndarray) -> np.ndarray:
-        """Set light travel time."""
+        """Set Spacecraft velocities."""
         return self._v
 
     def configure(
@@ -290,6 +301,7 @@ class Orbits(ABC):
 
     @property
     def pycppdetector_args(self) -> tuple:
+        """args for the c++ class."""
         return self._pycppdetector_args
 
     @pycppdetector_args.setter
@@ -311,30 +323,81 @@ class Orbits(ABC):
     def get_light_travel_times(
         self, t: float | np.ndarray, link: int
     ) -> float | np.ndarray:
+        """Compute light travel time as a function of time.
+
+        Computes with the c++ backend.
+
+        Args:
+            t: Time array in seconds.
+            link: which link. Must be ``in self.LINKS``.
+
+        Returns:
+            Light travel times.
+
+        """
         return self.pycppdetector.get_light_travel_time(t, link)
 
     def get_normal_unit_vec(self, t: float | np.ndarray, link: int) -> np.ndarray:
+        """Compute link normal vector as a function of time.
+
+        Computes with the c++ backend.
+
+        Args:
+            t: Time array in seconds.
+            link: which link. Must be ``in self.LINKS``.
+
+        Returns:
+            Link normal vectors.
+
+        """
         return self.pycppdetector.get_normal_unit_vec(t, link)
 
     def get_pos(self, t: float | np.ndarray, sc: int) -> np.ndarray:
+        """Compute spacecraft position as a function of time.
+
+        Computes with the c++ backend.
+
+        Args:
+            t: Time array in seconds.
+            sc: which spacecraft. Must be ``in self.SC``.
+
+        Returns:
+            Spacecraft positions.
+
+        """
         return self.pycppdetector.get_pos(t, sc)
 
     @property
     def ptr(self) -> int:
-        """pointer to c-class"""
+        """pointer to c++ class"""
         return self.pycppdetector.ptr
 
 
 class EqualArmlengthOrbits(Orbits):
-    """Equal Armlength Orbits"""
+    """Equal Armlength Orbits
+
+    Orbit file: equalarmlength-orbits.h5
+
+    """
 
     def __init__(self):
-        # TODO: fix this up
         super().__init__("equalarmlength-orbits.h5")
 
 
+class ESAOrbits(Orbits):
+    """ESA Orbits
+
+    Orbit file: esa-trailing-orbits.h5
+
+    """
+
+    def __init__(self):
+        # TODO: fix this up
+        super().__init__("esa-trailing-orbits.h5")
+
+
 class DefaultOrbits(EqualArmlengthOrbits):
-    """Set default orbit class to Equal Arm Length orbits for now."""
+    """Set default orbit class to Equal Armlength orbits for now."""
 
     pass
 
@@ -343,11 +406,10 @@ class DefaultOrbits(EqualArmlengthOrbits):
 class LISAModelSettings:
     """Required LISA model settings:
 
-    TODO: rename these
-
     Args:
         Soms_d: OMS displacement noise.
         Sa_a: Acceleration noise.
+        orbits: Orbital information.
         name: Name of model.
 
     """
@@ -359,7 +421,16 @@ class LISAModelSettings:
 
 
 class LISAModel(LISAModelSettings, ABC):
-    """Model for the LISA Constellation"""
+    """Model for the LISA Constellation
+
+    This includes sensitivity information computed in
+    :module:`lisatools.sensitivity` and orbital information
+    contained in an :class:`Orbits` class object.
+
+    This class is used to house high-level methods useful
+    to various needed computations.
+
+    """
 
     def __str__(self) -> str:
         out = "LISA Constellation Configurations Settings:\n"
@@ -368,6 +439,7 @@ class LISAModel(LISAModelSettings, ABC):
         return out
 
 
+# defaults
 scirdv1 = LISAModel((15.0e-12) ** 2, (3.0e-15) ** 2, DefaultOrbits(), "scirdv1")
 proposal = LISAModel((10.0e-12) ** 2, (3.0e-15) ** 2, DefaultOrbits(), "proposal")
 mrdv1 = LISAModel((10.0e-12) ** 2, (2.4e-15) ** 2, DefaultOrbits(), "mrdv1")