Release/1.0.1

README.md

@@ -103,3 +103,26 @@ In short, to interact with the project you can:
 - Submit a [Pull Request](https://github.com/LSSTDESC/BlendingToolKit/pulls) to contribute to the code.
 
 Issues marked with `contributions welcome` or `good first issue` are particularly good places to start. These are great ways to learn more about the inner workings of BTK.
+
+## Citing BTK
+
+If you use this software for your research, please cite using the following bibtex entry:
+
+```
+@ARTICLE{mendoza2024btk,
+       author = {{Mendoza}, Ismael and {Torchylo}, Andrii and {Sainrat}, Thomas and {Guinot}, Axel and {Boucaud}, Alexandre and {Paillassa}, Maxime and {Avestruz}, Camille and {Adari}, Prakruth and {Aubourg}, Eric and {Biswas}, Biswajit and {Buchanan}, James and {Burchat}, Patricia and {Doux}, Cyrille and {Joseph}, Remy and {Kamath}, Sowmya and {Malz}, Alex I. and {Merz}, Grant and {Miyatake}, Hironao and {Roucelle}, C{\'e}cile and {Zhang}, Tianqing and {the LSST Dark Energy Science Collaboration}},
+        title = "{The Blending ToolKit: A simulation framework for evaluation of galaxy detection and deblending}",
+      journal = {arXiv e-prints},
+     keywords = {Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Cosmology and Nongalactic Astrophysics},
+         year = 2024,
+        month = sep,
+          eid = {arXiv:2409.06986},
+        pages = {arXiv:2409.06986},
+          doi = {10.48550/arXiv.2409.06986},
+archivePrefix = {arXiv},
+       eprint = {2409.06986},
+ primaryClass = {astro-ph.IM},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2024arXiv240906986M},
+      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+}
+```

docs/source/index.rst

@@ -10,6 +10,28 @@
 
 Detecting and separating overlapping sources, or "deblending", is primarily a research problem with several potential algorithmic solutions, including machine learning approaches. Computation of performance metrics on identical datasets will enable comparison between different algorithms. The goals of the BTK framework are to allow the user to easily and quickly generate datasets of blended objects for testing different detection, deblending and measurement algorithms, as well as training samples for machine learning algorithms.
 
+If you use this software for your research, please use the following bibtex entry to cite:
+
+::
+
+   @ARTICLE{mendoza2024btk,
+         author = {{Mendoza}, Ismael and {Torchylo}, Andrii and {Sainrat}, Thomas and {Guinot}, Axel and {Boucaud}, Alexandre and {Paillassa}, Maxime and {Avestruz}, Camille and {Adari}, Prakruth and {Aubourg}, Eric and {Biswas}, Biswajit and {Buchanan}, James and {Burchat}, Patricia and {Doux}, Cyrille and {Joseph}, Remy and {Kamath}, Sowmya and {Malz}, Alex I. and {Merz}, Grant and {Miyatake}, Hironao and {Roucelle}, C{\'e}cile and {Zhang}, Tianqing and {the LSST Dark Energy Science Collaboration}},
+         title = "{The Blending ToolKit: A simulation framework for evaluation of galaxy detection and deblending}",
+         journal = {arXiv e-prints},
+      keywords = {Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Cosmology and Nongalactic Astrophysics},
+            year = 2024,
+         month = sep,
+            eid = {arXiv:2409.06986},
+         pages = {arXiv:2409.06986},
+            doi = {10.48550/arXiv.2409.06986},
+   archivePrefix = {arXiv},
+         eprint = {2409.06986},
+   primaryClass = {astro-ph.IM},
+         adsurl = {https://ui.adsabs.harvard.edu/abs/2024arXiv240906986M},
+         adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+   }
+
+
 Getting Started
 ==================
 .. toctree::

pyproject.toml

@@ -23,7 +23,7 @@ keywords = ["cosmology", "galaxies", "blending", "lsst", "simulation"]
 license = "MIT"
 name = "blending_toolkit"
 readme = "README.md"
-version = "1.0.0"
+version = "1.0.1"
 packages = [{ include = "btk" }]
 repository = "https://github.com/LSSTDESC/BlendingToolKit"
 homepage = "https://lsstdesc.org/BlendingToolKit/index.html"