lisainstrument 2.1.0__tar.gz → 2.2.0__tar.gz

{lisainstrument-2.1.0 → lisainstrument-2.2.0}/PKG-INFO

@@ -1,18 +1,17 @@
 Metadata-Version: 2.3
 Name: lisainstrument
-Version: 2.1.0
+Version: 2.2.0
 Summary: Simulates the LISA measurement chain (noise and signals) and generates telemetry data
 Home-page: https://gitlab.in2p3.fr/lisa-simulation/instrument
 License: BSD 3-Clause
 Author: Jean-Baptiste Bayle
 Author-email: j2b.bayle@gmail.com
-Maintainer: Jean-Baptiste Bayle
-Maintainer-email: j2b.bayle@gmail.com
-Requires-Python: >=3.10,<4.0
+Maintainer: Wolfgang Kastaun
+Maintainer-email: wolfgang.kastaun@aei.mpg.de
+Requires-Python: >=3.11,<4.0
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: Other/Proprietary License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -27,7 +26,7 @@ Requires-Dist: lisaconstants (>=2.0.1,<3.0.0)
 Requires-Dist: matplotlib (>=3.9.2,<4.0.0)
 Requires-Dist: numpy (>=2.1.2,<3.0.0)
 Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
-Requires-Dist: scipy (>=1.14.1,<2.0.0)
+Requires-Dist: scipy (>=1.17.1,<2.0.0)
 Requires-Dist: typing-extensions (>=4.15.0,<5.0.0)
 Project-URL: Documentation, https://lisa-simulation.pages.in2p3.fr/instrument
 Project-URL: Download, https://gitlab.in2p3.fr/lisa-simulation/instrument/-/releases

{lisainstrument-2.1.0 → lisainstrument-2.2.0}/lisainstrument/instru/instru_file_reader.py

@@ -79,7 +79,7 @@ class SimResultFile:
         Arguments:
             path: Path of the a HDF5 file created by store_instru_hdf5
         """
-        self._h5f = h5py.File(str(path), "r")
+        self._h5f_raw = h5py.File(str(path), "r")
         self._version: Final = Version(self._h5f.attrs["version_format"])
 
         if not SimResultFile.format_specifier().contains(self._version):
@@ -126,9 +126,34 @@ class SimResultFile:
             i: _unique_index_range(r) for i, r in ranges.items()
         }
 
+    @property
+    def _h5f(self) -> h5py.File:
+        if self._h5f_raw is None:
+            msg = "SimResultFile used after closing it"
+            raise RuntimeError(msg)
+        return self._h5f_raw
+
+    def close(self) -> None:
+        """Close file
+
+        Note the interface provides a context manager, consider using `with`
+        mechanism instead
+        """
+        if self._h5f_raw is not None:
+            self._h5f_raw.close()
+            self._h5f_raw = None
+
     def __del__(self):
-        """File is automatically closed"""
-        self._h5f.close()
+        """HDF5 file is automatically closed"""
+        self.close()
+
+    def __enter__(self):
+        """Enter context"""
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """Exit context"""
+        self.close()
 
     @property
     def format_version(self) -> Version:

{lisainstrument-2.1.0 → lisainstrument-2.2.0}/lisainstrument/instru/instru_file_reader_v2_0_0.py

@@ -70,7 +70,7 @@ class SimResultFile:
         Arguments:
             path: Path of the a HDF5 file created by store_instru_hdf5
         """
-        self._h5f = h5py.File(str(path), "r")
+        self._h5f_raw = h5py.File(str(path), "r")
         self._version: Final = Version(self._h5f.attrs["version_format"])
 
         if not SimResultFile.format_specifier().contains(self._version):
@@ -117,9 +117,34 @@ class SimResultFile:
             i: _unique_index_range(r) for i, r in ranges.items()
         }
 
+    @property
+    def _h5f(self) -> h5py.File:
+        if self._h5f_raw is None:
+            msg = "SimResultFile used after closing it"
+            raise RuntimeError(msg)
+        return self._h5f_raw
+
+    def close(self) -> None:
+        """Close file
+
+        Note the interface provides a context manager, consider using `with`
+        mechanism instead
+        """
+        if self._h5f_raw is not None:
+            self._h5f_raw.close()
+            self._h5f_raw = None
+
     def __del__(self):
-        """File is automatically closed"""
-        self._h5f.close()
+        """HDF5 file is automatically closed"""
+        self.close()
+
+    def __enter__(self):
+        """Enter context"""
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """Exit context"""
+        self.close()
 
     @property
     def format_version(self) -> Version:

{lisainstrument-2.1.0 → lisainstrument-2.2.0}/lisainstrument/instru/instru_formulas.py

@@ -245,22 +245,28 @@ def scet_wrt_tps_distant(
 def adjacent_carrier_fluctuations(
     local_carrier_fluctuations_: np.ndarray | float,
     backlink_noises_: np.ndarray | float,
+    reciprocal_backlink_noises_: np.ndarray | float,
     *,
     central_freq: float,
 ) -> np.ndarray | float:
     """Compute adjacent_carrier_fluctuations"""
-    return local_carrier_fluctuations_ + central_freq * backlink_noises_
+    return local_carrier_fluctuations_ + central_freq * (
+        backlink_noises_ + reciprocal_backlink_noises_
+    )
 
 
 @stream_expression(np.float64)
 def adjacent_usb_fluctuations(
     adjacent_usb_fluctuations_: np.ndarray | float,
     backlink_noises_: np.ndarray | float,
+    reciprocal_backlink_noises_: np.ndarray | float,
     *,
     central_freq: float,
 ) -> np.ndarray | float:
     """Compute adjacent_usb_fluctuations"""
-    return adjacent_usb_fluctuations_ + central_freq * backlink_noises_
+    return adjacent_usb_fluctuations_ + central_freq * (
+        backlink_noises_ + reciprocal_backlink_noises_
+    )
 
 
 @for_each_mosa

{lisainstrument-2.1.0 → lisainstrument-2.2.0}/lisainstrument/instru/instru_model.py

@@ -456,6 +456,7 @@ class ModelConstellation:  # pylint: disable = too-few-public-methods
             mosa.value: compute.adjacent_usb_fluctuations(
                 self.local_usb_fluctuations[mosa.adjacent.value],
                 self.backlink_noises[mosa.value],
+                self.reciprocal_backlink_noises[mosa.sat.value],
                 central_freq=cfg.central_freq,
             )
             for mosa in MosaID
@@ -1511,6 +1512,9 @@ class ModelConstellation:  # pylint: disable = too-few-public-methods
         ## Backlink noise
 
         self.backlink_noises = self._generate_noise_mosas(noises.noise_def_backlink)
+        self.reciprocal_backlink_noises = self._generate_noise_sats(
+            noises.noise_def_reciprocal_backlink
+        )
 
         ## Test-mass acceleration noise
 
@@ -1704,6 +1708,7 @@ class ModelConstellation:  # pylint: disable = too-few-public-methods
             compute.adjacent_carrier_fluctuations(
                 results.local_carrier_fluctuations[mosa.adjacent],
                 self.backlink_noises[mosa.value],
+                self.reciprocal_backlink_noises[mosa.sat.value],
                 central_freq=cfg.central_freq,
             )
         )
@@ -1863,6 +1868,7 @@ class ModelConstellation:  # pylint: disable = too-few-public-methods
                     compute.adjacent_carrier_fluctuations(
                         results.local_carrier_fluctuations[mosa.adjacent],
                         self.backlink_noises[mosa.value],
+                        self.reciprocal_backlink_noises[mosa.sat.value],
                         central_freq=cfg.central_freq,
                     )
                 )

{lisainstrument-2.1.0 → lisainstrument-2.2.0}/lisainstrument/instru/instru_noises.py

@@ -22,6 +22,7 @@ from lisainstrument.noisy import (
     NoiseDefModulation,
     NoiseDefOMS,
     NoiseDefRanging,
+    NoiseDefReciprocalBacklink,
     NoiseDefTestMass,
     TestMassNoiseShape,
 )
@@ -40,6 +41,7 @@ class InstruNoisesConfig:
     modulation_asds: dict[MosaID, float]
     ranging_asds: dict[MosaID, float]
     backlink_asds: dict[MosaID, float]
+    reciprocal_backlink_asds: dict[SatID, float]
     backlink_fknees: dict[MosaID, float]
     testmass_asds: dict[MosaID, float]
     testmass_fknees: dict[MosaID, float]
@@ -133,6 +135,15 @@ class InstruNoises:  # pylint: disable = too-many-public-methods
             name=f"backlink_{mosa.value}",
         )
 
+    def noise_def_reciprocal_backlink(self, sc: SatID) -> NoiseDefBase:
+        """Definition of reciprocal backlink noise used for given SC"""
+        cfg = self._config
+        return NoiseDefReciprocalBacklink(
+            displacement_asd_onesided=cfg.reciprocal_backlink_asds[sc],
+            f_sample=cfg.physics_fs,
+            name=f"reciprocal_backlink_sc_{sc.value}",
+        )
+
     def noise_def_testmass(self, mosa: MosaID) -> NoiseDefBase:
         """Definition of testmass noise used for given MOSA"""
         cfg = self._config

{lisainstrument-2.1.0 → lisainstrument-2.2.0}/lisainstrument/instru/instru_store.py

@@ -518,6 +518,9 @@ class SimMoreDatasetsSat:
     scet_wrt_tcb_withinitial: SamplesSatsType = _dataset(
         False, False, IdxSpace.PHYSICS_EXT
     )
+    reciprocal_backlink_noises: SamplesSatsType = _dataset(
+        False, False, IdxSpace.PHYSICS
+    )
 
 
 @dataclass(kw_only=True, frozen=True)
@@ -644,6 +647,7 @@ class SimMetaData:
     ranging_asds: dict[str, float]
     prn_ambiguity: float | None
     backlink_asds: dict[str, float]
+    reciprocal_backlink_asds: dict[str, float]
     backlink_fknees: dict[str, float]
     testmass_asds: dict[str, float]
     testmass_fknees: dict[str, float]

{lisainstrument-2.1.0 → lisainstrument-2.2.0}/lisainstrument/instrument.py

@@ -95,7 +95,8 @@ class Instrument:
         fplan: path to frequency-plan file, dictionary of locking beatnote frequencies [Hz],
             or 'static' for a default set of constant locking beatnote frequencies
         laser_asds: dictionary of amplitude spectral densities for laser noise [Hz/sqrt(Hz)]
-        laser_shape: laser noise spectral shape, either 'white' or 'white+infrared'
+        laser_shape: laser noise spectral shape, choices are 'white', 'white+infrared',
+            'white+infrared_stationary'
         central_freq: laser central frequency from which all offsets are computed [Hz]
         offset_freqs: dictionary of laser frequency offsets for unlocked lasers [Hz],
             defined with respect to :attr:`lisainstrument.Instrument.central_freq`,
@@ -116,10 +117,13 @@ class Instrument:
         clockinv_maxiter: maximum number of iterations for clock noise inversion
         backlink_asds: dictionary of amplitude spectral densities for backlink noise [m/sqrt(Hz)]
         backlink_fknees: dictionary of cutoff frequencied for backlink noise [Hz]
+        reciprocal_backlink_asds: dictionary of amplitude spectral densities
+            for reciprocal backlink noise [m/sqrt(Hz)]
         testmass_asds: dictionary of amplitude spectral densities for test-mass noise [ms^(-2)/sqrt(Hz)]
         testmass_fknees: dictionary of low-frequency cutoff frequencies for test-mass noise [Hz]
         testmass_fbreak: dictionary of high-frequency break frequencies for test-mass noise [Hz]
-        testmass_shape: test-mass noise spectral shape, either 'original' or 'lowfreq-relax'
+        testmass_shape: test-mass noise spectral shape, choices are 'original', 'original-stationary',
+            'lowfreq-relax', 'lowfreq-relax-stationary'
         testmass_frelax: dictionary of low-frequency relaxation frequencies for test-mass noise [Hz]
         oms_asds: tuple of dictionaries of amplitude spectral densities for OMS noise [m/sqrt(Hz)],
             ordered as (sci_carrier, sci_usb, tmi_carrier, tmi_usb, ref_carrier, ref_usb)
@@ -197,7 +201,7 @@ class Instrument:
         lock: str | dict[str, str] = "N1-12",
         fplan: str | float | dict[str, float] | np.ndarray = "static",
         laser_asds: float | dict[str, float] = 30.0,
-        laser_shape: str = "white+infrared",
+        laser_shape: str = "white+infrared_stationary",
         central_freq: float = 2.816e14,
         offset_freqs="default",
         # Laser phase modulation
@@ -216,11 +220,12 @@ class Instrument:
         # Backlink noises
         backlink_asds: float | dict[str, float] = 3e-12,
         backlink_fknees: float | dict[str, float] = 2e-3,
+        reciprocal_backlink_asds: float | dict[str, float] = 1.7e-9,
         # Test-mass noise
         testmass_asds: float | dict[str, float] = 2.4e-15,
         testmass_fknees: float | dict[str, float] = 0.4e-3,
         testmass_fbreak: float | dict[str, float] = 8e-3,
-        testmass_shape: str = "original",
+        testmass_shape: str = "original-stationary",
         testmass_frelax: float | dict[str, float] = 0.8e-4,
         # OMS noise
         oms_asds: tuple[float | dict[str, float], ...] = (
@@ -469,9 +474,9 @@ class Instrument:
             laser_asds, "laser_asds"
         )
 
-        if laser_shape not in ["white", "white+infrared"]:
+        if laser_shape not in {e.value for e in LaserNoiseShape}:
             raise ValueError(f"invalid laser noise spectral shape '{laser_shape}'")
-        self.laser_shape = laser_shape
+        self.laser_shape: Final[str] = str(laser_shape)
 
         match modulation_asds:
             case "default":
@@ -621,6 +626,10 @@ class Instrument:
             backlink_fknees, "backlink_fknees"
         )
 
+        self.reciprocal_backlink_asds: Final[SatDictFloat] = param_sat_dict_float(
+            reciprocal_backlink_asds, "reciprocal_backlink_asds"
+        )
+
         match oms_asds:
             case (sci_carrier, sci_usb, tmi_carrier, tmi_usb, ref_carrier, ref_usb):
                 self.oms_sci_carrier_asds: Final[MosaDictFloat] = param_mosa_dict_float(
@@ -650,11 +659,11 @@ class Instrument:
         )
 
         # Test-mass noise
-        if testmass_shape not in ["original", "lowfreq-relax"]:
+        if testmass_shape not in {e.value for e in TestMassNoiseShape}:
             raise ValueError(
                 f"invalid test-mass noise spectral shape '{testmass_shape}'"
             )
-        self.testmass_shape: Final[str] = testmass_shape
+        self.testmass_shape: Final[str] = str(testmass_shape)
 
         self.testmass_asds: Final[MosaDictFloat] = param_mosa_dict_float(
             testmass_asds, "testmass_asds"
@@ -857,6 +866,7 @@ class Instrument:
             ranging_asds=make_mosa_id_dict(self.ranging_asds),
             backlink_asds=make_mosa_id_dict(self.backlink_asds),
             backlink_fknees=make_mosa_id_dict(self.backlink_fknees),
+            reciprocal_backlink_asds=make_sat_id_dict(self.reciprocal_backlink_asds),
             testmass_asds=make_mosa_id_dict(self.testmass_asds),
             testmass_fknees=make_mosa_id_dict(self.testmass_fknees),
             testmass_fbreak=make_mosa_id_dict(self.testmass_fbreak),
@@ -943,8 +953,9 @@ class Instrument:
 
         Args:
             excluding: noises to keep on, to be chosen in ('laser', 'modulation',
-                'clock', 'test-mass', 'backlink', 'oms', 'ranging', 'angular-jitters', 'dws',
-                'moc-time-correlation', 'longitudinal-jitters')
+                'clock', 'test-mass', 'backlink', 'reciprocal_backlink', 'oms',
+                'ranging', 'angular-jitters', 'dws', 'moc-time-correlation',
+                'longitudinal-jitters')
         """
 
         valid_noises = {
@@ -953,6 +964,7 @@ class Instrument:
             "clock": self.disable_clock_noise,
             "test-mass": self.disable_testmass_noise,
             "backlink": self.disable_backlink_noise,
+            "reciprocal_backlink": self.disable_reciprocal_backlink_noise,
             "oms": self.disable_oms_noise,
             "ranging": self.disable_ranging_noises,
             "angular-jitters": self.disable_angular_jitters,
@@ -1007,6 +1019,11 @@ class Instrument:
         logger.info("disable backlink noise")
         self.backlink_asds = make_mosa_dict_const(0.0)
 
+    def disable_reciprocal_backlink_noise(self):
+        """Turn off reciprocal backlink noise."""
+        logger.info("disable reciprocal backlink noise")
+        self.reciprocal_backlink_asds = make_sat_dict_const(0.0)
+
     def disable_oms_noise(self):
         """Turn off OMS noise in all interferometers."""
         logger.info("disable oms noise")

{lisainstrument-2.1.0 → lisainstrument-2.2.0}/lisainstrument/noisy/__init__.py

@@ -16,13 +16,17 @@ from .noise_defs import (
     NoiseDefBase,
     NoiseDefCumSum,
     NoiseDefFalloff6,
+    NoiseDefFalloff6Stat,
     NoiseDefFalloff8,
+    NoiseDefFalloff8Stat,
     NoiseDefFiltered,
     NoiseDefGradient,
     NoiseDefInfraRed,
+    NoiseDefInfraRedStat,
     NoiseDefPink,
     NoiseDefPowerLaw,
     NoiseDefRed,
+    NoiseDefRedPow,
     NoiseDefScaled,
     NoiseDefSum,
     NoiseDefViolet,
@@ -45,6 +49,7 @@ from .noise_defs_lisa import (
     NoiseDefModulation,
     NoiseDefOMS,
     NoiseDefRanging,
+    NoiseDefReciprocalBacklink,
     NoiseDefTestMass,
     TestMassNoiseShape,
 )