Skip to content

Commit

Permalink
Merge pull request #337 from sibirrer/main
Browse files Browse the repository at this point in the history
minor updates in documentation and readme
  • Loading branch information
sibirrer committed Aug 11, 2022
2 parents 220cd76 + 9fe9008 commit 83e373e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
15 changes: 7 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,24 @@ lenstronomy - gravitational lensing software package
.. image:: https://coveralls.io/repos/github/lenstronomy/lenstronomy/badge.svg?branch=main
:target: https://coveralls.io/github/lenstronomy/lenstronomy?branch=main

.. image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat
.. image:: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg
:target: https://github.com/lenstronomy/lenstronomy/blob/main/LICENSE

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

.. 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://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 package to model strong gravitational lenses. The software package is presented in
`Birrer & Amara 2018 <https://arxiv.org/abs/1803.09746v1>`_ and `Birrer et al. 2021 <https://joss.theoj.org/papers/10.21105/joss.03283>`_ , and is based on `Birrer et al 2015 <http://adsabs.harvard.edu/abs/2015ApJ...813..102B>`_.
``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.
Expand Down Expand Up @@ -120,9 +119,9 @@ and become an author of ``lenstronomy``! A big shout-out to the current `list of

Attribution
-----------
The design concept of ``lenstronomy`` is reported by `Birrer & Amara 2018 <https://arxiv.org/abs/1803.09746v1>`_.
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 these two publications when you use lenstronomy in a publication and link to `https://github.com/lenstronomy/lenstronomy <https://github.com/sibirrer/lenstronomy>`_.
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.
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@

# General information about the project.
project = u'lenstronomy'
copyright = u'2018-2022, Simon Birrer and contributors'
copyright = u'2018-2022, lenstronomy developers'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down

0 comments on commit 83e373e

Please sign in to comment.