fastlisaresponse 1.0.2__tar.gz

fastlisaresponse-1.0.2/MANIFEST.in

@@ -0,0 +1,30 @@
+# Include the README
+include README
+
+# Include the license file
+include LICENCE
+include THIRD.txt
+
+# Include dependencies
+include requirements*.txt
+
+# Include makefile
+include Makefile
+
+# Include docs
+recursive-include docs
+
+# Include Changelog
+include CHANGELOG
+
+# Include tests
+recursive-include tests/testsuites  *
+
+# Include scripts
+recursive-include scripts   *
+
+# Include tuto
+include tutorial/*.ipynb
+
+# Include include files
+include include/*

fastlisaresponse-1.0.2/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.1
+Name: fastlisaresponse
+Version: 1.0.2
+Home-page: https://github.com/mikekatz04/lisa-on-gpu
+Author: Michael Katz
+Author-email: mikekatz04@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License (GPL)
+Classifier: Environment :: GPU :: NVIDIA CUDA
+Classifier: Natural Language :: English
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Cython
+Classifier: Programming Language :: Python :: 3.7
+Requires-Python: >=3.6
+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 # TODO fix [Zenodo](https://zenodo.org/record/3981654#.XzS_KRNKjlw).
+
+If you use all or any parts of this code, please cite (TODO: fill in ). See the [documentation](https://mikekatz04.github.io/lisa-on-gpu/) to properly cite specific modules.
+
+## Getting Started
+
+Below is a quick set of instructions to get you started with `fastlisaresponse`.
+
+0) [Install Anaconda](https://docs.anaconda.com/anaconda/install/) if you do not have it.
+
+1) Create a virtual environment. **Note**: There is no available `conda` compiler for Windows. If you want to install for Windows, you will probably need to add libraries and include paths to the `setup.py` file.
+
+```
+conda create -n lisa_env -c conda-forge gcc_linux-64 gxx_linux-64 numpy Cython scipy jupyter ipython h5py matplotlib python=3.9
+conda activate lisa_env
+```
+
+    If on MACOSX, substitute `gcc_linux-64` and `gxx_linus-64` with `clang_osx-64` and `clangxx_osx-64`.
+
+2) Clone the repository.
+
+```
+git clone https://github.com/mikekatz04/lisa-on-gpu.git
+cd lisa-on-gpu
+```
+
+3) Run install.
+
+```
+python setup.py install
+```
+
+4) 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
+
+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
+
+
+0) [Install Anaconda](https://docs.anaconda.com/anaconda/install/) if you do not have it.
+
+1) Create a virtual environment.
+
+```
+conda create -n lisa_env -c conda-forge gcc_linux-64 gxx_linux-64 numpy Cython scipy jupyter ipython h5py matplotlib python=3.9
+conda activate few_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/BlackHolePerturbationToolkit/FastEMRIWaveforms.git
+cd FastEMRIWaveforms
+```
+
+3) If using GPUs, use pip to [install cupy](https://docs-cupy.chainer.org/en/stable/install.html). If you have cuda version 9.2, for example:
+
+```
+pip install cupy-cuda92
+```
+
+4) Run install. Make sure CUDA is on your PATH.
+
+```
+python setup.py install
+```
+
+## Running the Tests
+
+Since the code package in minimal in size, the example notebook should be run to verify it is running correctly.
+
+
+## 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.2
+
+## 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.0.2/README.md

@@ -0,0 +1,120 @@
+# 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 # TODO fix [Zenodo](https://zenodo.org/record/3981654#.XzS_KRNKjlw).
+
+If you use all or any parts of this code, please cite (TODO: fill in ). See the [documentation](https://mikekatz04.github.io/lisa-on-gpu/) to properly cite specific modules.
+
+## Getting Started
+
+Below is a quick set of instructions to get you started with `fastlisaresponse`.
+
+0) [Install Anaconda](https://docs.anaconda.com/anaconda/install/) if you do not have it.
+
+1) Create a virtual environment. **Note**: There is no available `conda` compiler for Windows. If you want to install for Windows, you will probably need to add libraries and include paths to the `setup.py` file.
+
+```
+conda create -n lisa_env -c conda-forge gcc_linux-64 gxx_linux-64 numpy Cython scipy jupyter ipython h5py matplotlib python=3.9
+conda activate lisa_env
+```
+
+    If on MACOSX, substitute `gcc_linux-64` and `gxx_linus-64` with `clang_osx-64` and `clangxx_osx-64`.
+
+2) Clone the repository.
+
+```
+git clone https://github.com/mikekatz04/lisa-on-gpu.git
+cd lisa-on-gpu
+```
+
+3) Run install.
+
+```
+python setup.py install
+```
+
+4) 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
+
+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
+
+
+0) [Install Anaconda](https://docs.anaconda.com/anaconda/install/) if you do not have it.
+
+1) Create a virtual environment.
+
+```
+conda create -n lisa_env -c conda-forge gcc_linux-64 gxx_linux-64 numpy Cython scipy jupyter ipython h5py matplotlib python=3.9
+conda activate few_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/BlackHolePerturbationToolkit/FastEMRIWaveforms.git
+cd FastEMRIWaveforms
+```
+
+3) If using GPUs, use pip to [install cupy](https://docs-cupy.chainer.org/en/stable/install.html). If you have cuda version 9.2, for example:
+
+```
+pip install cupy-cuda92
+```
+
+4) Run install. Make sure CUDA is on your PATH.
+
+```
+python setup.py install
+```
+
+## Running the Tests
+
+Since the code package in minimal in size, the example notebook should be run to verify it is running correctly.
+
+
+## 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.2
+
+## 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.0.2/fastlisaresponse/__init__.py

@@ -0,0 +1 @@
+from .response import pyResponseTDI, ResponseWrapper

fastlisaresponse-1.0.2/fastlisaresponse/_version.py

@@ -0,0 +1 @@
+__version__ = '1.0.2'

fastlisaresponse-1.0.2/fastlisaresponse/pointer_adjust.py

@@ -0,0 +1,33 @@
+import numpy as np
+
+try:
+    import cupy as cp
+
+    gpu = True
+
+except (ImportError, ModuleNotFoundError) as e:
+    gpu = False
+
+
+def pointer_adjust(func):
+    def func_wrapper(*args, **kwargs):
+        targs = []
+        for arg in args:
+            if gpu:
+                if isinstance(arg, cp.ndarray):
+                    targs.append(arg.data.mem.ptr)
+                    continue
+
+            if isinstance(arg, np.ndarray):
+                targs.append(arg.__array_interface__["data"][0])
+                continue
+
+            try:
+                targs.append(arg.ptr)
+                continue
+            except AttributeError:
+                targs.append(arg)
+
+        return func(*targs, **kwargs)
+
+    return func_wrapper