From 439dc641c34216c6ef82064291338027ab545a63 Mon Sep 17 00:00:00 2001 From: "Sterling G. Baird" Date: Sat, 1 Mar 2025 05:00:48 -0500 Subject: [PATCH] Add citation section and arXiv badge to index.md --- docs/index.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 48ec3faf..805ff232 100644 --- a/docs/index.md +++ b/docs/index.md @@ -24,7 +24,7 @@
-# Honegumi: An Interface for Accelerating the Adoption of Bayesian Optimization in the Experimental Sciences +# Honegumi: An Interface for Accelerating the Adoption of Bayesian Optimization in the Experimental Sciences [![arXiv](https://img.shields.io/badge/arXiv-2502.06815-red.svg)](https://arxiv.org/abs/2502.06815) ```{tip} New to Bayesian optimization? Start with [A Gentle Introduction to Bayesian Optimization](https://youtu.be/IVaWl2tL06c) and explore our [concept guides](https://honegumi.readthedocs.io/en/latest/concepts.html) and [coding tutorials](https://honegumi.readthedocs.io/en/latest/tutorials.html) on key optimization principles. @@ -73,6 +73,31 @@ While Large Language Models excel at pattern recognition, they often struggle to +## Citing + +If you find Honegumi useful, please consider citing: + +> Baird, Sterling G., Andrew R. Falkowski, and Taylor D. Sparks. "Honegumi: An Interface for Accelerating the Adoption of Bayesian Optimization in the Experimental Sciences." *arXiv*, February 4, 2025. https://doi.org/10.48550/arXiv.2502.06815. + +```bibtex +@misc{baird_honegumi_2025, + title = {Honegumi: {{An Interface}} for {{Accelerating}} the {{Adoption}} of {{Bayesian Optimization}} in the {{Experimental Sciences}}}, + shorttitle = {Honegumi}, + author = {Baird, Sterling G. and Falkowski, Andrew R. and Sparks, Taylor D.}, + year = {2025}, + month = feb, + number = {arXiv:2502.06815}, + eprint = {2502.06815}, + primaryclass = {cs}, + publisher = {arXiv}, + doi = {10.48550/arXiv.2502.06815}, + archiveprefix = {arXiv}, + keywords = {Computer Science - Machine Learning,Condensed Matter - Materials Science}, +} +``` + +Zenodo snapshots of the GitHub releases (beginning with `v0.3.2`) are available at [![DOI](https://zenodo.org/badge/658136354.svg)](https://doi.org/10.5281/zenodo.14949415) + ## Contents ```{toctree}