Data

Tools

Indexes

Applications

Experiments

Open Source Science

lenstronomy

Multi-purpose lens modeling software package

https://github.com/lenstronomy/lenstronomy

Science Score: 77.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 2 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: arxiv.org, joss.theoj.org
  • ✓
    Committers with academic emails
    13 of 43 committers (30.2%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.8%) to scientific vocabulary

Keywords

astronomy astrophysics astropy-affiliated cosmology galaxies galaxy-morphology gravitational-lensing image-simulation lenstronomy strong-lensing

Keywords from Contributors

standardization Deconvolution psf
Last synced: 6 months ago · JSON representation ·

Repository

Multi-purpose lens modeling software package

Basic Info
Statistics
  • Stars: 207
  • Watchers: 11
  • Forks: 108
  • Open Issues: 29
  • Releases: 36
Topics
astronomy astrophysics astropy-affiliated cosmology galaxies galaxy-morphology gravitational-lensing image-simulation lenstronomy strong-lensing
Created about 9 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Authors

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

  • Name: lenstronomy project
  • Login: lenstronomy
  • Kind: organization

multi-purpose gravitational lensing software

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

Total
  • Create event: 8
  • Issues event: 12
  • Release event: 7
  • Watch event: 18
  • Delete event: 1
  • Member event: 1
  • Issue comment event: 155
  • Push event: 88
  • Pull request review comment event: 142
  • Pull request review event: 173
  • Pull request event: 184
  • Fork event: 12
Last Year
  • Create event: 8
  • Issues event: 12
  • Release event: 7
  • Watch event: 18
  • Delete event: 1
  • Member event: 1
  • Issue comment event: 155
  • Push event: 88
  • Pull request review comment event: 142
  • Pull request review event: 173
  • Pull request event: 184
  • Fork event: 12

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 3,019
  • Total Committers: 43
  • Avg Commits per committer: 70.209
  • Development Distribution Score (DDS): 0.545
Past Year
  • Commits: 358
  • Committers: 19
  • Avg Commits per committer: 18.842
  • Development Distribution Score (DDS): 0.609
Top Committers
Name Email Commits
sibirrer s****r@g****m 1,373
Simon Birrer s****r@p****h 575
Aymeric Galan a****n@g****m 243
Daniel Gilman g****a@u****u 223
Anowar Jaman Shajib a****b@g****m 144
Simon Birrer s****r@u****m 77
nataliehogg m****l@n****m 59
Luca Teodori l****o@g****m 36
Ewoud Wempe w****e@a****l 34
martin-millon m****n@e****h 28
Jelle Aalbers j****s@g****m 22
Madi Ueland m****d@s****u 18
mattgomer m****r@g****m 17
Maverick-Oh m****h@g****m 15
vikram b****v@s****k 15
lilan y****n@m****n 14
Jack O'Donnell j****l@g****m 13
Nanz z****0@o****m 13
Giulia Pagano g****3@g****m 11
jiwoncpark j****k@g****m 11
Daniel Gilman d****n@D****l 8
LyneVdV L****e@u****e 7
Pierre Fleury p****y@g****m 7
Matt G m****r@u****e 7
Ewoud e****d@h****m 6
Pierre Fleury 8****y@u****m 5
Robert Morgan 3****0@u****m 5
Sebastian Wagner-Carena s****c@s****u 5
Anna a****2@g****m 4
Lyne VdV l****e@u****e 4
and 13 more...
Committer Domains (Top 20 + Academic)
uliege.be: 3 stanford.edu: 2 pyhs.ethz.ch: 1 ucla.edu: 1 nataliebhogg.com: 1 astro.rug.nl: 1 epfl.ch: 1 stpaulsschool.org.uk: 1 mail.bnu.edu.cn: 1 myuct.ac.za: 1 manchester.ac.uk: 1 dna80cf6e.sunet: 1 ieee.org: 1 ucl.ac.uk: 1 dna80d3d4.sunet: 1 proton.me: 1 slac.stanford.edu: 1 umich.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 36
  • Total pull requests: 333
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 13 days
  • Total issue authors: 19
  • Total pull request authors: 37
  • Average comments per issue: 2.56
  • Average comments per pull request: 1.67
  • Merged pull requests: 289
  • Bot issues: 0
  • Bot pull requests: 12
Past Year
  • Issues: 7
  • Pull requests: 77
  • Average time to close issues: 28 days
  • Average time to close pull requests: 7 days
  • Issue authors: 6
  • Pull request authors: 19
  • Average comments per issue: 1.43
  • Average comments per pull request: 1.17
  • Merged pull requests: 60
  • Bot issues: 0
  • Bot pull requests: 1
View more stats
Top Authors
Issue Authors
  • ajshajib (7)
  • amn3142 (6)
  • sibirrer (5)
  • PierreBoccard (2)
  • dangilman (2)
  • smericks (1)
  • aymgal (1)
  • zijun-gao (1)
  • cfbradshaw (1)
  • LyneVdV (1)
  • Tabibrh (1)
  • HouSiyuan2001 (1)
  • martin-millon (1)
  • Hadrien-Pgnt (1)
  • PrayaagKatta (1)
Pull Request Authors
  • sibirrer (198)
  • ajshajib (35)
  • dangilman (31)
  • ahuang314 (24)
  • pre-commit-ci[bot] (17)
  • nataliehogg (13)
  • aymgal (11)
  • nanz6 (10)
  • Hadrien-Pgnt (8)
  • jocelyn-mcmahon-16 (5)
  • martin-millon (5)
  • AlexKurek (4)
  • RosettaGit (4)
  • mattgomer (4)
  • astrobenji (4)
Top Labels
Issue Labels
enhancement (6) help wanted (5) bug (3) documentation (1)
Pull Request Labels
enhancement (3) bug (2) documentation (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 1,614 last-month
  • Total dependent packages: 6
    (may contain duplicates)
  • Total dependent repositories: 19
    (may contain duplicates)
  • Total versions: 84
  • Total maintainers: 1
pypi.org: lenstronomy

Strong lens modeling package.

  • Versions: 80
  • Dependent Packages: 6
  • Dependent Repositories: 19
  • Downloads: 1,614 Last month
Rankings
Dependent packages count: 3.3%
Dependent repos count: 3.4%
Average: 4.6%
Forks count: 4.8%
Stargazers count: 5.6%
Downloads: 5.9%
Maintainers (1)
sibirrer
Last synced: 6 months ago
conda-forge.org: lenstronomy
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Forks count: 20.1%
Stargazers count: 28.5%
Average: 33.5%
Dependent repos count: 34.0%
Dependent packages count: 51.2%
Last synced: 6 months ago

Dependencies

docs/requirements.txt pypi
  • docutils <0.18
requirements.txt pypi
  • astropy *
  • corner >=2.2.1
  • dynesty *
  • emcee >=3.0.0
  • h5py *
  • matplotlib *
  • mpmath *
  • multiprocess >=0.70.8
  • nestcheck *
  • numba >=0.43.1
  • numpy >=1.17
  • pymultinest *
  • pyxdg *
  • pyyaml *
  • schwimmbad *
  • scikit-image *
  • scikit-learn *
  • scipy >=0.19.1
  • slitronomy ==0.3.2
test_requirements.txt pypi
  • colossus *
Gemfile rubygems
  • coveralls >= 0
.github/workflows/ci_test.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
setup.py pypi