PyAutoLens-JAX: Open-Source Strong Lensing

.. |nbsp| unicode:: 0xA0 :trim:

.. |binder| image:: https://mybinder.org/badge_logo.svg :target: https://mybinder.org/v2/gh/Jammy2211/autolens_workspace/HEAD

.. |RTD| image:: https://readthedocs.org/projects/pyautolens/badge/?version=latest :target: https://pyautolens.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

.. |Tests| image:: https://github.com/Jammy2211/PyAutoLens/actions/workflows/main.yml/badge.svg :target: https://github.com/Jammy2211/PyAutoLens/actions

.. |Build| image:: https://github.com/Jammy2211/PyAutoBuild/actions/workflows/release.yml/badge.svg :target: https://github.com/Jammy2211/PyAutoBuild/actions

.. |code-style| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black

.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.02825/status.svg :target: https://doi.org/10.21105/joss.02825

.. |arXiv| image:: https://img.shields.io/badge/arXiv-1708.07377-blue :target: https://arxiv.org/abs/1708.07377

.. image:: https://www.repostatus.org/badges/latest/active.svg :target: https://www.repostatus.org/#active :alt: Project Status: Active

.. image:: https://img.shields.io/pypi/pyversions/autolens :target: https://pypi.org/project/autolens/ :alt: Python Versions

.. image:: https://img.shields.io/pypi/v/autolens.svg :target: https://pypi.org/project/autolens/ :alt: PyPI Version

|binder| |RTD| |Tests| |Build| |code-style| |JOSS| |arXiv|

Installation Guide <https://pyautolens.readthedocs.io/en/latest/installation/overview.html>_ | readthedocs <https://pyautolens.readthedocs.io/en/latest/index.html>_ | Introduction on Colab <https://colab.research.google.com/github/Jammy2211/autolens_workspace/blob/release/start_here.ipynb>_ | HowToLens <https://pyautolens.readthedocs.io/en/latest/howtolens/howtolens.html>_

.. image:: https://github.com/Jammy2211/PyAutoLogo/blob/main/gifs/pyautolens.gif?raw=true :width: 900

When two or more galaxies are aligned perfectly down our line-of-sight, the background galaxy appears multiple times.

This is called strong gravitational lensing and PyAutoLens makes it simple to model strong gravitational lenses, using JAX to accelerate lens modeling on GPUs.

Getting Started

The following links are useful for new starters:

• The PyAutoLens readthedocs <https://pyautolens.readthedocs.io/en/latest>: which includes an overview of PyAutoLens's core features <https://pyautolens.readthedocs.io/en/latest/overview/overview_1_start_here.html>, a new user starting guide <https://pyautolens.readthedocs.io/en/latest/overview/overview_2_new_user_guide.html>_ and an installation guide <https://pyautolens.readthedocs.io/en/latest/installation/overview.html>_.

• The introduction Jupyter Notebook on Google Colab <https://colab.research.google.com/github/Jammy2211/autolens_workspace/blob/release/start_here.ipynb>_: try PyAutoLens in a web browser (without installation).

• The autolens_workspace GitHub repository <https://github.com/Jammy2211/autolens_workspace>_: example scripts and the HowToLens Jupyter notebook lectures.

Community & Support

Support for PyAutoLens is available via our Slack workspace, where the community shares updates, discusses gravitational lensing analysis, and helps troubleshoot problems.

Slack is invitation-only. If you’d like to join, please send an email requesting an invite.

For installation issues, bug reports, or feature requests, please raise an issue on the GitHub issues page <https://github.com/Jammy2211/PyAutoLens/issues>_.

HowToLens

For users less familiar with gravitational lensing, Bayesian inference and scientific analysis you may wish to read through the HowToLens lectures. These teach you the basic principles of gravitational lensing and Bayesian inference, with the content pitched at undergraduate level and above.

A complete overview of the lectures is provided on the HowToLens readthedocs page <https://pyautolens.readthedocs.io/en/latest/howtolens/howtolens.html>_.

Citations

Information on how to cite PyAutoLens in publications can be found on the citations page <https://github.com/Jammy2211/PyAutoLens/blob/main/CITATIONS.rst>_.

Contributing

Information on how to contribute to PyAutoLens can be found on the contributing page <https://github.com/Jammy2211/PyAutoLens/blob/main/CONTRIBUTING.md>_.

Hands on support for contributions is available via our Slack workspace, again please email to request an invite.