lenstronomy II

lenstronomy II: A gravitational lensing software ecosystem - Published in JOSS (2021)

https://github.com/sibirrer/lenstronomy

Keywords from Contributors

Scientific Fields

Repository

multi-purpose lens modeling software package

README.rst

.. image:: https://raw.githubusercontent.com/lenstronomy/lenstronomy/main/docs/figures/logo_text.png
    :target: https://raw.githubusercontent.com/lenstronomy/lenstronomy/main/docs/figures/logo_text.png
    :alt: Lenstronomy Logo

.. image:: https://github.com/lenstronomy/lenstronomy/workflows/Tests/badge.svg
    :target: https://github.com/lenstronomy/lenstronomy/actions
    :alt: GitHub Tests Badge

.. image:: https://readthedocs.org/projects/lenstronomy/badge/?version=latest
    :target: http://lenstronomy.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status Badge

.. image:: https://codecov.io/gh/lenstronomy/lenstronomy/graph/badge.svg?token=Pk1FmwQ4Ek 
    :target: https://codecov.io/gh/lenstronomy/lenstronomy
    :alt: Code Coverage Badge

.. image:: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg
    :target: https://github.com/lenstronomy/lenstronomy/blob/main/LICENSE
    :alt: License BSD 3-Clause Badge

.. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
    :target: http://www.astropy.org
    :alt: Powered by Astropy Badge

.. image:: https://joss.theoj.org/papers/6a562375312c9a9e4466912a16f27589/status.svg
    :target: https://joss.theoj.org/papers/6a562375312c9a9e4466912a16f27589
    :alt: JOSS Publication Status Badge

.. image:: https://img.shields.io/badge/arXiv-1803.09746%20-yellowgreen.svg
    :target: https://arxiv.org/abs/1803.09746
    :alt: arXiv 1803.09746 Badge

.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=brightyellow
    :target: https://pre-commit.com/

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style Black Badge

.. image:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg
    :target: https://github.com/PyCQA/docformatter
    :alt: Docformatter Formatter Badge

.. image:: https://img.shields.io/badge/%20style-sphinx-0a507a.svg
    :target: https://www.sphinx-doc.org/en/master/usage/index.html
    :alt: Sphinx Documentation Style Badge

..
    .. image:: https://raw.githubusercontent.com/lenstronomy/lenstronomy/main/docs/figures/readme_fig.png
        :target: https://raw.githubusercontent.com/lenstronomy/lenstronomy/main/docs/figures/readme_fig.png
        :alt: Lenstronomy Example Image

``lenstronomy`` is a multi-purpose software package to model strong gravitational lenses.
``lenstronomy`` finds application for time-delay cosmography and measuring
the expansion rate of the Universe, for quantifying lensing substructure to infer dark matter properties, morphological quantification of galaxies,
quasar-host galaxy decomposition and much more.
A (incomplete) list of publications making use of lenstronomy can be found `at this link `_.


The development is coordinated on `GitHub `_ and contributions are welcome.
The documentation of ``lenstronomy`` is available at `readthedocs.org `_ and
the package is distributed through PyPI_ and conda-forge_.
``lenstronomy`` is an `affiliated package `_ of `astropy `_.



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

|PyPI| |conda-forge|

``lenstronomy`` releases are distributed through PyPI_ and conda-forge_. Instructions for
installing lenstronomy and its dependencies can be found in the Installation_
section of the documentation.
Specific instructions for settings and installation requirements for special cases that can provide speed-ups,
we also refer to the Installation_ page.

.. |PyPI| image:: https://img.shields.io/pypi/v/lenstronomy?label=PyPI&logo=pypi
    :target: https://pypi.python.org/pypi/lenstronomy

.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/lenstronomy?logo=conda-forge
    :target: https://anaconda.org/conda-forge/lenstronomy

.. _PyPI: https://pypi.org/project/lenstronomy/
.. _conda-forge: https://anaconda.org/conda-forge/lenstronomy
.. _Installation: https://lenstronomy.readthedocs.io/en/stable/installation.html


Getting started
---------------

The `starting guide jupyter notebook `_
leads through the main modules and design features of ``lenstronomy``. The modular design of ``lenstronomy`` allows the
user to directly access a lot of tools and each module can also be used as stand-alone packages.

If you are new to gravitational lensing, check out the `mini lecture series `_ giving an introduction to gravitational lensing
with interactive Jupyter notebooks in the cloud.



Example notebooks
-----------------

We have made an extension module available at `https://github.com/lenstronomy/lenstronomy-tutorials `_.
You can find simple example notebooks for various cases. The latest versions of the notebooks should be compatible with the recent pip version of lenstronomy.



Affiliated packages
-------------------
Multiple affiliated packages that make use of lenstronomy can be found `here `_
(not complete) and further packages are under development by the community.


Mailing list and Slack channel
------------------------------

You can join the ``lenstronomy`` mailing list by signing up on the
`google groups page `_.


The email list is meant to provide a communication platform between users and developers. You can ask questions,
and suggest new features. New releases will be announced via this mailing list.

We also have a `Slack channel `_ for the community.
Please send us an `email `_ such that we can add you to the channel.


If you encounter errors or problems with ``lenstronomy``, please let us know!



Contribution
------------
We welcome EVERY contribution from EVERYONE! See our `code of conduct `_.

Check out the `contributing page `_
and become an author of ``lenstronomy``! A big shout-out to the current `list of contributors and developers `_!



Attribution
-----------
The design concept of ``lenstronomy`` is reported by `Birrer & Amara 2018 `_ and is based on `Birrer et al 2015 `_.
The current JOSS software publication is presented by `Birrer et al. 2021 `_.
Please cite `Birrer & Amara 2018 `_ and `Birrer et al. 2021 `_ when you use lenstronomy in a publication and link to `https://github.com/lenstronomy/lenstronomy `_.
Please also cite `Birrer et al 2015 `_
when you make use of the ``lenstronomy`` work-flow or the Shapelet source reconstruction and make sure to cite also
the relevant work that was implemented in ``lenstronomy``, as described in the release paper and the documentation.
Don't hesitate to reach out to the developers if you have questions!

Owner

JOSS Publication

lenstronomy II: A gravitational lensing software ecosystem

Published

June 08, 2021

DOI

10.21105/joss.03283

Volume 6, Issue 62, Page 3283

Authors

Simon Birrer
Kavli Institute for Particle Astrophysics and Cosmology and Department of Physics, Stanford University, Stanford, CA 94305, USA, SLAC National Accelerator Laboratory, Menlo Park, CA, 94025, USA

Anowar J. Shajib
Department of Astronomy & Astrophysics, University of Chicago, Chicago, IL 60637, USA, Department of Physics and Astronomy, University of California, Los Angeles, CA 90095, USA

Daniel Gilman
Department of Astronomy and Astrophysics, University of Toronto, 50 St. George Street, Toronto, ON, M5S 3H4, Canada

Aymeric Galan
Institute of Physics, Laboratory of Astrophysics, Ecole Polytechnique Fédérale de Lausanne (EPFL), Switzerland

Jelle Aalbers
Kavli Institute for Particle Astrophysics and Cosmology and Department of Physics, Stanford University, Stanford, CA 94305, USA, SLAC National Accelerator Laboratory, Menlo Park, CA, 94025, USA

Martin Millon
Institute of Physics, Laboratory of Astrophysics, Ecole Polytechnique Fédérale de Lausanne (EPFL), Switzerland

Robert Morgan
Physics Department, University of Wisconsin-Madison, 1150 University Avenue Madison, WI 53706, USA, Legacy Survey of Space and Time Corporation Data Science Fellowship Program, USA

Giulia Pagano
Independent Researcher

Ji Won Park
Kavli Institute for Particle Astrophysics and Cosmology and Department of Physics, Stanford University, Stanford, CA 94305, USA, SLAC National Accelerator Laboratory, Menlo Park, CA, 94025, USA

Luca Teodori
Weizmann Institute, 234 Herzl Street, Rehovot, 7610001 Israel

Nicolas Tessore
Department of Physics and Astronomy, University College London, Gower Street, London, WC1E 6BT, UK

Madison Ueland
Kavli Institute for Particle Astrophysics and Cosmology and Department of Physics, Stanford University, Stanford, CA 94305, USA

Lyne Van de Vyvere
STAR Institute, Université de Liège, Quartier Agora - Allée du six Août, 19c, B-4000 Liège, Belgium

Sebastian Wagner-Carena
Kavli Institute for Particle Astrophysics and Cosmology and Department of Physics, Stanford University, Stanford, CA 94305, USA, SLAC National Accelerator Laboratory, Menlo Park, CA, 94025, USA

Ewoud Wempe
Kapteyn Astronomical Institute, University of Groningen, PO Box 800, 9700 AV Groningen, the Netherlands

Lilan Yang
School of Physics and Technology, Wuhan University, Wuhan 430072, China

Xuheng Ding
Kavli IPMU (WPI), UTIAS, The University of Tokyo, Kashiwa, Chiba 277-8583, Japan

Thomas Schmidt
Department of Physics and Astronomy, University of California, Los Angeles, CA 90095, USA

Dominique Sluse
STAR Institute, Université de Liège, Quartier Agora - Allée du six Août, 19c, B-4000 Liège, Belgium

Ming Zhang
Xinjiang Astronomical Observatory, Chinese Academy of Sciences, 150 Science 1-Street, Urumqi 831001, China

Adam Amara
Institute of Cosmology and Gravitation, University of Portsmouth, Portsmouth PO1 3FX, UK

Editor

Daniel S. Katz

Tags

astronomy gravitational lensing image simulations dynamics

View PDF Review Thread Software Archive

Citation (CITATION.rst)

Citation Guidelines
===================

|JOSS| |Birrer&Amara|

If you use lenstronomy for work or research presented in a publication (whether
directly, or as a dependency of another package) we recommend and encourage
the following acknowledgment:

  This research made use of lenstronomy, a multi-purpose gravitational lens
  modeling software package (Birrer et. al., 2021, Birrer & Amara, 2018).

where the citations are to our publication in the `Journal of Open Source
Software`_ and the `Original Publication`_. We also encourage citations within the main text wherever
appropriate. DOIs and BibTeX keys are available through the links above.

Please also cite `Birrer et al 2015 <http://adsabs.harvard.edu/abs/2015ApJ...813..102B>`_
when you make use of the lenstronomy work-flow or the Shapelet source reconstruction and make sure to cite also
the relevant work that was implemented in lenstronomy, as described in the release paper and the documentation.
Don't hesitate to reach out to the developers if you have questions!


.. _Journal of Open Source Software: https://joss.theoj.org/papers/10.21105/joss.03283
.. _Original Publication: https://ui.adsabs.harvard.edu/abs/2018PDU....22..189B/abstract

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

.. |Birrer&Amara| image:: https://img.shields.io/badge/arXiv-1803.09746%20-yellowgreen.svg
    :target: https://ui.adsabs.harvard.edu/abs/2018PDU....22..189B/abstract

GitHub Events

Committers

Last synced: 5 months ago

Issues and Pull Requests

Last synced: 4 months ago