fastlisaresponse 1.1.14__cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

fastlisaresponse/utils/exceptions.py

@@ -0,0 +1,95 @@
+"""Definition of FASTLISA package common exceptions"""
+
+try:
+    from exceptiongroup import ExceptionGroup
+except (ImportError, ModuleNotFoundError):
+    ExceptionGroup = ExceptionGroup
+
+
+class FASTLISAException(Exception):
+    """Base class for FASTLISA package exceptions."""
+
+    pass
+
+
+class CudaException(FASTLISAException):
+    """Base class for CUDA-related exceptions."""
+
+    pass
+
+
+class CuPyException(FASTLISAException):
+    """Base class for CuPy-related exceptions."""
+
+    pass
+
+
+class MissingDependency(FASTLISAException):
+    """Exception raised when a required dependency is missing."""
+
+    pass
+
+
+class InvalidInputFile(FASTLISAException):
+    """Exception raised when the content of an input file does not match expectations."""
+
+
+class ConfigurationError(FASTLISAException):
+    """Exception raised when configuration setup fails."""
+
+
+class ConfigurationMissing(ConfigurationError):
+    """Exception raised when an expected configuration entry is missing."""
+
+
+class ConfigurationValidationError(ConfigurationError):
+    """Exception raised when a configuration entry is invalid."""
+
+
+class FileManagerException(FASTLISAException):
+    """Exception raised by the FileManager."""
+
+
+class FileNotInRegistry(FileManagerException):
+    """Exception raised when a requested file is not in file registry."""
+
+
+class FileNotFoundLocally(FileManagerException):
+    """Exception raised when file not found locally but expected to be."""
+
+
+class FileInvalidChecksum(FileManagerException):
+    """Exception raised when file has invalid checksum."""
+
+
+class FileDownloadException(FileManagerException):
+    """Exception raised if file download failed."""
+
+
+class FileDownloadNotFound(FileDownloadException):
+    """Exception raised if file is not found at expected URL."""
+
+
+class FileDownloadConnectionError(FileDownloadException):
+    """Exception raised in case of connection error during download."""
+
+
+class FileDownloadIntegrityError(FileDownloadException):
+    """Exception raised in case of integrity error after download."""
+
+
+class FileManagerDisabledAccess(FileManagerException):
+    """Exception raised when trying to access a file whose tags are disabled"""
+
+    disabled_tag: str
+    file_name: str
+
+    def __init__(self, /, *args, disabled_tag: str, file_name: str, **kwargs):
+        self.disabled_tag = disabled_tag
+        self.file_name = file_name
+        super().__init__(*args, **kwargs)
+
+
+### Trajectory-related exceptions
+class TrajectoryOffGridException(Exception):
+    """Exception raised when a trajectory goes off-grid (except for the lower boundary in p)."""

fastlisaresponse/utils/parallelbase.py

@@ -0,0 +1,11 @@
+from typing import Optional, Sequence, TypeVar, Union
+import types
+
+
+from gpubackendtools import ParallelModuleBase
+
+
+class FastLISAResponseParallelModule(ParallelModuleBase):
+    def __init__(self, force_backend=None):
+        force_backend_in = ('fastlisaresponse', force_backend) if isinstance(force_backend, str) else force_backend
+        super().__init__(force_backend_in)

fastlisaresponse/utils/utility.py

@@ -0,0 +1,82 @@
+import numpy as np
+
+try:
+    import cupy as cp
+    from pyresponse import get_response_wrap as get_response_wrap_gpu
+    from pyresponse import get_tdi_delays_wrap as get_tdi_delays_wrap_gpu
+
+    gpu = True
+
+except (ImportError, ModuleNotFoundError) as e:
+    import numpy as xp
+
+    gpu = False
+
+
+def get_overlap(sig1, sig2, phase_maximize=False, use_gpu=False):
+    """Calculate the mismatch across TDI channels
+
+    Calculates the overlap between two sets of TDI observables in the time
+    domain. The overlap is complex allowing for the addition of overlap
+    over all channels. It can be phase maximized as well.
+
+    This function has GPU capabilities.
+
+    Args:
+        sig1 (list or xp.ndarray): TDI observables for first signal. Must be ``list`` of
+            ``xp.ndarray`` or a single ``xp.ndarray``. Must have same length as ``sig2`` in terms
+            of number of channels and length of the indivudal channels.
+        sig2 (list or xp.ndarray): TDI observables for second signal. Must be ``list`` of
+            ``xp.ndarray`` or a single ``xp.ndarray``. Must have same length as ``sig1`` in terms
+            of number of channels and length of the individual channels.
+        phase_maximize (bool, optional): If ``True``, maximize over the phase in the overlap.
+            This is equivalent to getting the magnitude of the phasor that is the complex
+            overlap. (Defaut: ``False``)
+        use_gpu (bool, optional): If ``True``, use the GPU. This sets ``xp=cupy``. If ``False,
+            use the CPU and set ``xp=numpy``.
+
+    Returns:
+        double: Overlap as a real value.
+
+    """
+
+    # choose right array library
+    if use_gpu:
+        xp = cp
+    else:
+        xp = np
+
+    # check inputs
+    if not isinstance(sig1, list):
+        if not isinstance(sig1, xp.ndarray):
+            raise ValueError("sig1 must be list of or single xp.ndarray.")
+
+        elif sig1.ndim < 2:
+            sig1 = [sig1]
+
+    if not isinstance(sig2, list):
+        if not isinstance(sig2, xp.ndarray):
+            raise ValueError("sig1 must be list of or single xp.ndarray.")
+
+        elif sig1.ndim < 2:
+            sig2 = [sig2]
+
+    assert len(sig1) == len(sig2)
+    assert len(sig1[0]) == len(sig2[0])
+
+    # complex overlap
+    overlap = 0.0 + 1j * 0.0
+    for sig1_i, sig2_i in zip(sig1, sig2):
+        overlap_i = np.dot(np.fft.rfft(sig1_i).conj(), np.fft.rfft(sig2_i)) / np.sqrt(
+            np.dot(np.fft.rfft(sig1_i).conj(), np.fft.rfft(sig1_i))
+            * np.dot(np.fft.rfft(sig2_i).conj(), np.fft.rfft(sig2_i))
+        )
+        overlap += overlap_i
+
+    overlap /= len(sig1)
+
+    if phase_maximize:
+        return np.abs(overlap)
+
+    else:
+        return overlap.real

fastlisaresponse-1.1.14.dist-info/METADATA

@@ -0,0 +1,166 @@
+Metadata-Version: 2.2
+Name: fastlisaresponse
+Version: 1.1.14
+Summary: GPU-accelerated LISA Response Function
+Author-Email: Michael Katz <mikekatz04@gmail.com>
+Classifier: Environment :: GPU :: NVIDIA CUDA
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Cython
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Requires-Dist: lisaanalysistools>=1.1.16
+Requires-Dist: exceptiongroup; python_version < "3.11"
+Requires-Dist: h5py<3.15
+Requires-Dist: matplotlib
+Requires-Dist: gpubackendtools
+Requires-Dist: jsonschema
+Requires-Dist: lisaconstants
+Requires-Dist: multispline
+Requires-Dist: numba
+Requires-Dist: numpy
+Requires-Dist: nvidia-ml-py
+Requires-Dist: platformdirs
+Requires-Dist: pydantic
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Requires-Dist: rich
+Requires-Dist: scipy
+Requires-Dist: tqdm
+Requires-Dist: wrapt
+Provides-Extra: doc
+Requires-Dist: ipykernel; extra == "doc"
+Requires-Dist: ipython; extra == "doc"
+Requires-Dist: ipywidgets; extra == "doc"
+Requires-Dist: myst-parser; extra == "doc"
+Requires-Dist: nbsphinx; extra == "doc"
+Requires-Dist: pypandoc; extra == "doc"
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: sphinx-rtd-theme; extra == "doc"
+Requires-Dist: sphinx-tippy; extra == "doc"
+Requires-Dist: astropy; extra == "doc"
+Provides-Extra: sampling
+Requires-Dist: eryn; extra == "sampling"
+Requires-Dist: astropy; extra == "sampling"
+Provides-Extra: testing
+Requires-Dist: matplotlib; extra == "testing"
+Requires-Dist: astropy; extra == "testing"
+Description-Content-Type: text/markdown
+
+# fastlisaresponse: Generic LISA response function for GPUs
+
+This code base provides a GPU-accelerated version of the generic time-domain LISA response function. The GPU-acceleration allows this code to be used directly in Parameter Estimation.
+
+Please see the [documentation](https://mikekatz04.github.io/lisa-on-gpu/) for further information on these modules. The code can be found on Github [here](https://github.com/mikekatz04/lisa-on-gpu). It can be found on [Zenodo](https://zenodo.org/records/17162632).
+
+If you use all or any parts of this code, please cite [arXiv:2204.06633](https://arxiv.org/abs/2204.06633). See the [documentation](https://mikekatz04.github.io/lisa-on-gpu/) to properly cite specific modules.
+
+
+## Getting Started
+
+Install with pip:
+```
+pip install fastlisaresponse
+```
+To import fastlisaresponse:
+
+```
+from fastlisaresponse import ResponseWrapper
+```
+
+See [examples notebook](https://github.com/mikekatz04/lisa-on-gpu/blob/master/examples/fast_LISA_response_tutorial.ipynb).
+
+
+### Prerequisites
+
+Now (version 1.0.11) `fastlisaresponse` requires the newest version of [LISA Analysis Tools](github.com/mikekatz04/LISAanalysistools). You can run `pip install lisaanalysistools`.
+
+To install this software for CPU usage, you need Python >3.4 and NumPy. To run the examples, you will also need jupyter and matplotlib. We generally recommend installing everything, including gcc and g++ compilers, in the conda environment as is shown in the examples here. This generally helps avoid compilation and linking issues. If you use your own chosen compiler, you will need to make sure all necessary information is passed to the setup command (see below). You also may need to add information to the `setup.py` file.
+
+To install this software for use with NVIDIA GPUs (compute capability >2.0), you need the [CUDA toolkit](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html) and [CuPy](https://cupy.chainer.org/). The CUDA toolkit must have cuda version >8.0. Be sure to properly install CuPy within the correct CUDA toolkit version. Make sure the nvcc binary is on `$PATH` or set it as the `CUDAHOME` environment variable.
+
+
+### Installing
+
+
+Install with pip (CPU only for now):
+```
+pip install fastlisaresponse
+```
+
+To install from source:
+
+0) [Install Anaconda](https://docs.anaconda.com/anaconda/install/) if you do not have it.
+
+1) Create a virtual environment.
+
+```
+conda create -n lisa_resp_env -c conda-forge gcc_linux-64 gxx_linux-64 numpy Cython scipy jupyter ipython h5py matplotlib python=3.12
+conda activate lisa_resp_env
+```
+
+    If on MACOSX, substitute `gcc_linux-64` and `gxx_linus-64` with `clang_osx-64` and `clangxx_osx-64`.
+
+    If you want a faster install, you can install the python packages (numpy, Cython, scipy, tqdm, jupyter, ipython, h5py, requests, matplotlib) with pip.
+
+2) Clone the repository.
+
+```
+git clone https://github.com/mikekatz04/lisa-on-gpu.git
+cd lisa-on-gpu
+```
+
+3) If using GPUs, use pip to [install cupy](https://docs-cupy.chainer.org/en/stable/install.html). 
+
+```
+pip install cupy-12x
+```
+
+4) Run install. Make sure CUDA is on your PATH.
+
+```
+python scripts/prebuild.py
+pip install .
+```
+
+## Running the Tests
+
+Run the example notebook or the tests using `unittest` from the main directory of the code:
+```
+python -m unittest discover
+```
+
+## Contributing
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/mikekatz04/lisa-on-gpu/tags).
+
+Current Version: 1.0.11
+
+## Authors
+
+* **Michael Katz**
+* Jean-Baptiste Bayle
+* Alvin J. K. Chua
+* Michele Vallisneri
+
+### Contibutors
+
+* Maybe you!
+
+## License
+
+This project is licensed under the GNU License - see the [LICENSE.md](LICENSE.md) file for details.
+
+## Acknowledgments
+
+* It was also supported in part through the computational resources and staff contributions provided for the Quest/Grail high performance computing facility at Northwestern University.

fastlisaresponse-1.1.14.dist-info/RECORD

@@ -0,0 +1,17 @@
+fastlisaresponse_backend_cpu/git_version.py,sha256=r0r4TJdfJeDGyqULEUpINAuHil8mFWKB-L_SUOSM7K8,140
+fastlisaresponse_backend_cpu/responselisa.cpython-311-x86_64-linux-gnu.so,sha256=3TmTPJ0uzqSEUdMCKp2JMHOOqkAq2Vd9lxhKHtj47AI,249216
+fastlisaresponse-1.1.14.dist-info/WHEEL,sha256=SdD_Ze46rbG8O82pDF4NTDXbsCKrpf8pf8aQc3IgDLU,156
+fastlisaresponse-1.1.14.dist-info/METADATA,sha256=94scizJzJB222emuZqV6n0fAOk6hyn8qUpi5PPUXENU,6058
+fastlisaresponse-1.1.14.dist-info/RECORD,,
+fastlisaresponse/_version.py,sha256=LqGHDuI3LsZEbWsasOE2owH4mT6VrWmmmg7K1xYg7hM,706
+fastlisaresponse/git_version.py,sha256=r0r4TJdfJeDGyqULEUpINAuHil8mFWKB-L_SUOSM7K8,140
+fastlisaresponse/response.py,sha256=jQu6Z3kWui0gPv-_sRBgo3-M-NF0gRBzMG9oJHyz1XI,29512
+fastlisaresponse/git_version.py.in,sha256=Yt2d-2rBlJCK1XzVzjO81molm1_Nb_6NrYsxGuoCxmc,147
+fastlisaresponse/__init__.py,sha256=lqEQW-_q1ltPycsMvNZ70TgM6hJaOMIjvywWjKUesJ8,2478
+fastlisaresponse/cutils/__init__.py,sha256=SvtC-YZqLyS06vk0sPhZ56bd7dFdnzV4nMcPj1HLXuY,5282
+fastlisaresponse/utils/parallelbase.py,sha256=Hqkmggnz9Kkae910fz0_KvGLJ8EPIAQ6J_azdgDjlog,379
+fastlisaresponse/utils/utility.py,sha256=NrJdBmEnLkLPk6Ile1TZg8jNLw6xERiSp58iGVlz01s,2709
+fastlisaresponse/utils/citations.py,sha256=zf79Zb37isbgBmTa9YNZOaYnoOz7tRwHz_MShID_f8E,11150
+fastlisaresponse/utils/exceptions.py,sha256=ypqEROHLYcEdhQeI6k6TLzdtkr7ox0Hv7jx6tG9PK5U,2599
+fastlisaresponse/utils/config.py,sha256=dMdcOXTVNS9__DwynXInM2DGbBpwbB93IZI-EkQtisE,28450
+fastlisaresponse/utils/__init__.py,sha256=pf2NmWKs_uQNzlyA5iNO1gTRDISKNmIIsvOcKqQ3hgw,33

fastlisaresponse-1.1.14.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: scikit-build-core 0.11.6
+Root-Is-Purelib: false
+Tag: cp311-cp311-manylinux_2_17_x86_64
+Tag: cp311-cp311-manylinux2014_x86_64
+

fastlisaresponse_backend_cpu/git_version.py

@@ -0,0 +1,7 @@
+"""Metadata deduced from git at build time."""
+
+id: str
+short_id: str
+
+id = "b73cffeda71e2653428d8e35022a8be1c71a579f"
+short_id = "b73cffe"