.. 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
.. image:: https://github.com/lenstronomy/lenstronomy/workflows/Tests/badge.svg
:target: https://github.com/lenstronomy/lenstronomy/actions
.. image:: https://readthedocs.org/projects/lenstronomy/badge/?version=latest
:target: http://lenstronomy.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://codecov.io/gh/lenstronomy/lenstronomy/graph/badge.svg?token=Pk1FmwQ4Ek
:target: https://codecov.io/gh/lenstronomy/lenstronomy
.. image:: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg
:target: https://github.com/lenstronomy/lenstronomy/blob/main/LICENSE
.. 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
.. image:: https://img.shields.io/badge/arXiv-1803.09746%20-yellowgreen.svg
:target: https://arxiv.org/abs/1803.09746
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. image:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg
:target: https://github.com/PyCQA/docformatter
.. image:: https://img.shields.io/badge/%20style-sphinx-0a507a.svg
:target: https://www.sphinx-doc.org/en/master/usage/index.html
..
.. 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
``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 <https://github.com/lenstronomy/lenstronomy/blob/main/PUBLISHED.rst>`_.
The development is coordinated on `GitHub <https://github.com/lenstronomy/lenstronomy>`_ and contributions are welcome.
The documentation of ``lenstronomy`` is available at `readthedocs.org <http://lenstronomy.readthedocs.org/>`_ and
the package is distributed through PyPI_ and conda-forge_.
``lenstronomy`` is an `affiliated package <https://www.astropy.org/affiliated/>`_ of `astropy <https://www.astropy.org/>`_.
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 <https://github.com/lenstronomy/lenstronomy-tutorials/blob/main/Notebooks/GettingStarted/starting_guide.ipynb>`_
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 <https://github.com/sibirrer/strong_lensing_lectures>`_ 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 <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 <https://lenstronomy.readthedocs.io/en/latest/affiliatedpackages.html>`_
(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 <https://groups.google.com/forum/#!forum/lenstronomy>`_.
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 <https://lenstronomers.slack.com>`_ for the community.
Please send us an `email <lenstronomy-dev@googlegroups.com>`_ 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 <https://github.com/lenstronomy/lenstronomy/blob/main/CODE_OF_CONDUCT.rst>`_.
Check out the `contributing page <https://lenstronomy.readthedocs.io/en/latest/contributing.html>`_
and become an author of ``lenstronomy``! A big shout-out to the current `list of contributors and developers <https://lenstronomy.readthedocs.io/en/latest/authors.html>`_!
Attribution
-----------
The design concept of ``lenstronomy`` is reported by `Birrer & Amara 2018 <https://arxiv.org/abs/1803.09746v1>`_ and is based on `Birrer et al 2015 <http://adsabs.harvard.edu/abs/2015ApJ...813..102B>`_.
The current JOSS software publication is presented by `Birrer et al. 2021 <https://joss.theoj.org/papers/10.21105/joss.03283>`_.
Please cite `Birrer & Amara 2018 <https://arxiv.org/abs/1803.09746v1>`_ and `Birrer et al. 2021 <https://joss.theoj.org/papers/10.21105/joss.03283>`_ when you use lenstronomy in a publication and link to `https://github.com/lenstronomy/lenstronomy <https://github.com/lenstronomy/lenstronomy>`_.
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!
Raw data
{
"_id": null,
"home_page": "https://github.com/lenstronomy/lenstronomy",
"name": "lenstronomy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "lenstronomy",
"author": "lenstronomy developers",
"author_email": "lenstronomy-dev@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/d3/de/6bf86fc74009296ad2592234b7d907e4ef9e63c522ce2925661349a9401d/lenstronomy-1.12.1.tar.gz",
"platform": null,
"description": "\n.. image:: https://raw.githubusercontent.com/lenstronomy/lenstronomy/main/docs/figures/logo_text.png\n :target: https://raw.githubusercontent.com/lenstronomy/lenstronomy/main/docs/figures/logo_text.png\n\n.. image:: https://github.com/lenstronomy/lenstronomy/workflows/Tests/badge.svg\n :target: https://github.com/lenstronomy/lenstronomy/actions\n\n.. image:: https://readthedocs.org/projects/lenstronomy/badge/?version=latest\n :target: http://lenstronomy.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://codecov.io/gh/lenstronomy/lenstronomy/graph/badge.svg?token=Pk1FmwQ4Ek \n :target: https://codecov.io/gh/lenstronomy/lenstronomy\n\n.. image:: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg\n :target: https://github.com/lenstronomy/lenstronomy/blob/main/LICENSE\n\n.. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat\n :target: http://www.astropy.org\n :alt: Powered by Astropy Badge\n\n.. image:: https://joss.theoj.org/papers/6a562375312c9a9e4466912a16f27589/status.svg\n :target: https://joss.theoj.org/papers/6a562375312c9a9e4466912a16f27589\n\n.. image:: https://img.shields.io/badge/arXiv-1803.09746%20-yellowgreen.svg\n :target: https://arxiv.org/abs/1803.09746\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n.. image:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg\n :target: https://github.com/PyCQA/docformatter\n\n.. image:: https://img.shields.io/badge/%20style-sphinx-0a507a.svg\n :target: https://www.sphinx-doc.org/en/master/usage/index.html\n\n..\n .. image:: https://raw.githubusercontent.com/lenstronomy/lenstronomy/main/docs/figures/readme_fig.png\n :target: https://raw.githubusercontent.com/lenstronomy/lenstronomy/main/docs/figures/readme_fig.png\n\n\n``lenstronomy`` is a multi-purpose software package to model strong gravitational lenses.\n``lenstronomy`` finds application for time-delay cosmography and measuring\nthe expansion rate of the Universe, for quantifying lensing substructure to infer dark matter properties, morphological quantification of galaxies,\nquasar-host galaxy decomposition and much more.\nA (incomplete) list of publications making use of lenstronomy can be found `at this link <https://github.com/lenstronomy/lenstronomy/blob/main/PUBLISHED.rst>`_.\n\n\nThe development is coordinated on `GitHub <https://github.com/lenstronomy/lenstronomy>`_ and contributions are welcome.\nThe documentation of ``lenstronomy`` is available at `readthedocs.org <http://lenstronomy.readthedocs.org/>`_ and\nthe package is distributed through PyPI_ and conda-forge_.\n``lenstronomy`` is an `affiliated package <https://www.astropy.org/affiliated/>`_ of `astropy <https://www.astropy.org/>`_.\n\n\n\nInstallation\n------------\n\n|PyPI| |conda-forge|\n\nlenstronomy releases are distributed through PyPI_ and conda-forge_. Instructions for\ninstalling lenstronomy and its dependencies can be found in the Installation_\nsection of the documentation.\nSpecific instructions for settings and installation requirements for special cases that can provide speed-ups,\nwe also refer to the Installation_ page.\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/lenstronomy?label=PyPI&logo=pypi\n :target: https://pypi.python.org/pypi/lenstronomy\n\n.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/lenstronomy?logo=conda-forge\n :target: https://anaconda.org/conda-forge/lenstronomy\n\n.. _PyPI: https://pypi.org/project/lenstronomy/\n.. _conda-forge: https://anaconda.org/conda-forge/lenstronomy\n.. _Installation: https://lenstronomy.readthedocs.io/en/stable/installation.html\n\n\nGetting started\n---------------\n\nThe `starting guide jupyter notebook <https://github.com/lenstronomy/lenstronomy-tutorials/blob/main/Notebooks/GettingStarted/starting_guide.ipynb>`_\nleads through the main modules and design features of ``lenstronomy``. The modular design of ``lenstronomy`` allows the\nuser to directly access a lot of tools and each module can also be used as stand-alone packages.\n\nIf you are new to gravitational lensing, check out the `mini lecture series <https://github.com/sibirrer/strong_lensing_lectures>`_ giving an introduction to gravitational lensing\nwith interactive Jupyter notebooks in the cloud.\n\n\n\nExample notebooks\n-----------------\n\nWe have made an extension module available at `https://github.com/lenstronomy/lenstronomy-tutorials <https://github.com/lenstronomy/lenstronomy-tutorials>`_.\nYou can find simple example notebooks for various cases. The latest versions of the notebooks should be compatible with the recent pip version of lenstronomy.\n\n\n\nAffiliated packages\n-------------------\nMultiple affiliated packages that make use of lenstronomy can be found `here <https://lenstronomy.readthedocs.io/en/latest/affiliatedpackages.html>`_\n(not complete) and further packages are under development by the community.\n\n\nMailing list and Slack channel\n------------------------------\n\nYou can join the ``lenstronomy`` mailing list by signing up on the\n`google groups page <https://groups.google.com/forum/#!forum/lenstronomy>`_.\n\n\nThe email list is meant to provide a communication platform between users and developers. You can ask questions,\nand suggest new features. New releases will be announced via this mailing list.\n\nWe also have a `Slack channel <https://lenstronomers.slack.com>`_ for the community.\nPlease send us an `email <lenstronomy-dev@googlegroups.com>`_ such that we can add you to the channel.\n\n\nIf you encounter errors or problems with ``lenstronomy``, please let us know!\n\n\n\nContribution\n------------\nWe welcome EVERY contribution from EVERYONE! See our `code of conduct <https://github.com/lenstronomy/lenstronomy/blob/main/CODE_OF_CONDUCT.rst>`_.\n\nCheck out the `contributing page <https://lenstronomy.readthedocs.io/en/latest/contributing.html>`_\nand become an author of ``lenstronomy``! A big shout-out to the current `list of contributors and developers <https://lenstronomy.readthedocs.io/en/latest/authors.html>`_!\n\n\n\nAttribution\n-----------\nThe design concept of ``lenstronomy`` is reported by `Birrer & Amara 2018 <https://arxiv.org/abs/1803.09746v1>`_ and is based on `Birrer et al 2015 <http://adsabs.harvard.edu/abs/2015ApJ...813..102B>`_.\nThe current JOSS software publication is presented by `Birrer et al. 2021 <https://joss.theoj.org/papers/10.21105/joss.03283>`_.\nPlease cite `Birrer & Amara 2018 <https://arxiv.org/abs/1803.09746v1>`_ and `Birrer et al. 2021 <https://joss.theoj.org/papers/10.21105/joss.03283>`_ when you use lenstronomy in a publication and link to `https://github.com/lenstronomy/lenstronomy <https://github.com/lenstronomy/lenstronomy>`_.\nPlease also cite `Birrer et al 2015 <http://adsabs.harvard.edu/abs/2015ApJ...813..102B>`_\nwhen you make use of the ``lenstronomy`` work-flow or the Shapelet source reconstruction and make sure to cite also\nthe relevant work that was implemented in ``lenstronomy``, as described in the release paper and the documentation.\nDon't hesitate to reach out to the developers if you have questions!\n\n\n",
"bugtrack_url": null,
"license": "BSD-3",
"summary": "Strong lens modeling package.",
"version": "1.12.1",
"project_urls": {
"Download": "https://github.com/lenstronomy/lenstronomy/archive/1.12.1.tar.gz",
"Homepage": "https://github.com/lenstronomy/lenstronomy"
},
"split_keywords": [
"lenstronomy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3de6bf86fc74009296ad2592234b7d907e4ef9e63c522ce2925661349a9401d",
"md5": "77652d48c883eab5bb39d4f420c01463",
"sha256": "961e2da46d0c8d13caf66e6756bfd53d26eb088a23ed58a933400bcefb3ea132"
},
"downloads": -1,
"filename": "lenstronomy-1.12.1.tar.gz",
"has_sig": false,
"md5_digest": "77652d48c883eab5bb39d4f420c01463",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1816471,
"upload_time": "2024-11-05T19:27:14",
"upload_time_iso_8601": "2024-11-05T19:27:14.985093Z",
"url": "https://files.pythonhosted.org/packages/d3/de/6bf86fc74009296ad2592234b7d907e4ef9e63c522ce2925661349a9401d/lenstronomy-1.12.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-05 19:27:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lenstronomy",
"github_project": "lenstronomy",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
"<",
"2"
]
]
},
{
"name": "astropy",
"specs": []
},
{
"name": "scipy",
"specs": [
[
">=",
"0.19.1"
]
]
},
{
"name": "mpmath",
"specs": []
},
{
"name": "emcee",
"specs": [
[
">=",
"3.0.0"
]
]
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "scikit-learn",
"specs": []
},
{
"name": "numba",
"specs": []
},
{
"name": "dynesty",
"specs": []
},
{
"name": "pymultinest",
"specs": []
},
{
"name": "nestcheck",
"specs": []
},
{
"name": "corner",
"specs": [
[
">=",
"2.2.1"
]
]
},
{
"name": "scikit-image",
"specs": []
},
{
"name": "pyyaml",
"specs": []
},
{
"name": "pyxdg",
"specs": []
},
{
"name": "h5py",
"specs": []
},
{
"name": "zeus-mcmc",
"specs": []
},
{
"name": "cobaya",
"specs": []
},
{
"name": "nautilus-sampler",
"specs": [
[
">=",
"0.7"
]
]
},
{
"name": "schwimmbad",
"specs": [
[
">=",
"0.3.2"
]
]
},
{
"name": "multiprocess",
"specs": [
[
">=",
"0.70.8"
]
]
},
{
"name": "slitronomy",
"specs": [
[
"==",
"0.3.2"
]
]
}
],
"test_requirements": [
{
"name": "colossus",
"specs": []
},
{
"name": "SKiNN",
"specs": []
},
{
"name": "coolest",
"specs": []
},
{
"name": "starred-astro",
"specs": []
}
],
"tox": true,
"lcname": "lenstronomy"
}
JSON
