Metadata-Version: 2.4
Name: wolensing
Version: 0.0.12
Summary: A package for computing wave optics amplification factor.
Project-URL: Homepage, https://github.com/manchunyeung/wolensing
Author-email: "Simon Man-Chun Yeung, Mark Ho-Yeuk Cheung" <yeungm@uwm.edu>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: <3.12,>=3.9
Requires-Dist: astropy
Requires-Dist: extension-helpers
Requires-Dist: fast-histogram
Requires-Dist: jax>=0.4.27
Requires-Dist: jaxlib
Requires-Dist: lenstronomy<2,>=1.14.0
Requires-Dist: matplotlib
Requires-Dist: mpmath
Requires-Dist: numpy
Requires-Dist: pycbc
Requires-Dist: scipy>1.4.1
Requires-Dist: tqdm
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: numba; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Description-Content-Type: text/x-rst

.. image:: https://raw.githubusercontent.com/manchunyeung/wolensing/master/.github/images/wolensing.png
    :align: center

.. image:: https://github.com/manchunyeung/wolensing/actions/workflows/pytest.yaml/badge.svg
    :target: https://github.com/manchunyeung/wolensing/actions/workflows/pytest.yaml

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
    :target: https://github.com/mhycheung/jaxqualin/blob/main/LICENSE

.. image:: https://badgen.net/badge/Read/the doc/blue
    :target: https://wolensing.readthedocs.io/en/latest/

wolensing
=========

``wolensing`` is a software package to simulate lensed gravitational waves. It computes the full wave optics amplification factor within the range of LIGO sensitivity and is compatible with arbitrary lens models. ``wolensing`` also supports jax to accelerate the computation.

Installation
------------

``wolensing`` can be installed with github or pip::

  pip install wolensing


Examples Notebooks
-------------------

Examples notebooks showing the computation of wave optics amplification factor for different lens models and the plots of time delay contour are available at `https://github.com/manchunyeung/wolensing <https://github.com/manchunyeung/wolensing>`_



