slsim 0.1.1
LSST strong lensing simulation pipeline
License: MIT license
Requires Python: >=3.6
Keywords: slsim

==========================================
SLSim (Strong Lensing Simulation) pipeline
==========================================

|Read the Docs| |GitHub| |Codecov| |Black| |docformatter| |docstyle|


LSST strong lensing simulation pipeline.

This GitHub project originates from an intercollaboration agreement between
the two LSST Science collaborations:

- `Strong Lensing Science Collaboration (SLSC) <https://sites.google.com/view/lsst-stronglensing?pli=1>`_
- `Dark Energy Science Collaboration (DESC) <https://lsstdesc.org>`_

This repository provides the simulation tools for the purpose of conducting strong gravitational lensing science with the Vera C. Rubin Observatory.
All the tools are open-source available. Check out below how you can contribute and become part of the LSST strong lensing science.


* Free software: MIT license
* Documentation: https://slsim.readthedocs.io.


How to contribute to the repository?
------------------------------------
Check out our step-by-step instructions how you can contribute code to this project Contributing_ Guidelines.
Are you new to coding and contributing to a software development project? No worries! We help you out! Write us on the LSST Slack channel #sl-pipeline.

Note: `sim-pipeline` is written in object-oriented python. What fun!

How can I participate in LSST strong lensing projects?
------------------------------------------------------
We have a dedicated Onboarding_ page with all the information about the collaboration structure and how to become part of this project.
We are excited to having you part of the LSST strong lensing effort!


How can I give credit when using this package?
----------------------------------------------
We strive to acknowledge all contributors of this repository, be it direct code contributions or for the project at large.
See our Citation_ guidelines.


.. _Contributing: https://slsim.readthedocs.io/en/latest/contributing.html
.. _Onboarding: https://slsim.readthedocs.io/en/latest/onboarding.html
.. _Citation: https://slsim.readthedocs.io/en/latest/citation.html


.. |Read the Docs| image:: https://readthedocs.org/projects/slsim/badge/?version=latest
    :target: https://slsim.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. |GitHub| image:: https://github.com/LSST-strong-lensing/slsim/workflows/CI/badge.svg
    :target: https://github.com/LSST-strong-lensing/slsim/actions
    :alt: Build Status

.. |Codecov| image:: https://codecov.io/gh/LSST-strong-lensing/slsim/graph/badge.svg?token=PyDRdtsGSX
    :target: https://codecov.io/gh/LSST-strong-lensing/slsim
    :alt: Code coverage

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

.. |docstyle| image:: https://img.shields.io/badge/%20style-sphinx-0a507a.svg
    :target: https://www.sphinx-doc.org/en/master/usage/index.html

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


=======
History
=======

0.1.0 (2022-02-01)
------------------

* First sceleton.


0.1.1 (2025-11-10)
------------------

* First release of beta version