From 9f912f504d7e94f1ff7ee4a2bba1cf6200befaf8 Mon Sep 17 00:00:00 2001 From: Angel Ferran Pousa Date: Fri, 18 Aug 2023 13:46:37 +0200 Subject: [PATCH] Add citation information --- README.md | 2 +- doc/source/user_guide/citation.rst | 38 ++++++++++++++++++++++++++++++ doc/source/user_guide/index.rst | 8 ++++++- 3 files changed, 46 insertions(+), 2 deletions(-) create mode 100644 doc/source/user_guide/citation.rst diff --git a/README.md b/README.md index b4b358a1..93ab285c 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ We have prepared installation instructions for [Perlmutter (NERSC)](https://optimas.readthedocs.io/en/latest/user_guide/installation_perlmutter.html). ## Citing optimas -If your usage of `optimas` leads to a scientific publication, please consider citing the optimas paper: +If your usage of `optimas` leads to a scientific publication, please consider citing the original [paper](https://link.aps.org/doi/10.1103/PhysRevAccelBeams.26.084601): ```bibtex @article{PhysRevAccelBeams.26.084601, title = {Bayesian optimization of laser-plasma accelerators assisted by reduced physical models}, diff --git a/doc/source/user_guide/citation.rst b/doc/source/user_guide/citation.rst new file mode 100644 index 00000000..682ab91b --- /dev/null +++ b/doc/source/user_guide/citation.rst @@ -0,0 +1,38 @@ +Citing optimas +============== + +If your usage of ``optimas`` leads to a scientific publication, please consider +citing the original `paper `_: + +.. code-block:: bibtex + + @article{PhysRevAccelBeams.26.084601, + title = {Bayesian optimization of laser-plasma accelerators assisted by reduced physical models}, + author = {Ferran Pousa, A. and Jalas, S. and Kirchen, M. and Martinez de la Ossa, A. and Th\'evenet, M. and Hudson, S. and Larson, J. and Huebl, A. and Vay, J.-L. and Lehe, R.}, + journal = {Phys. Rev. Accel. Beams}, + volume = {26}, + issue = {8}, + pages = {084601}, + numpages = {9}, + year = {2023}, + month = {Aug}, + publisher = {American Physical Society}, + doi = {10.1103/PhysRevAccelBeams.26.084601}, + url = {https://link.aps.org/doi/10.1103/PhysRevAccelBeams.26.084601} + } + +and libEnsemble: + +.. code-block:: bibtex + + @article{Hudson2022, + title = {{libEnsemble}: A Library to Coordinate the Concurrent + Evaluation of Dynamic Ensembles of Calculations}, + author = {Stephen Hudson and Jeffrey Larson and John-Luke Navarro and Stefan M. Wild}, + journal = {{IEEE} Transactions on Parallel and Distributed Systems}, + volume = {33}, + number = {4}, + pages = {977--988}, + year = {2022}, + doi = {10.1109/tpds.2021.3082815} + } \ No newline at end of file diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 76fcedfe..1ebbc0d5 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -19,4 +19,10 @@ User guide basic_usage/basic_setup basic_usage/running_with_simulations - basic_usage/analyze_output \ No newline at end of file + basic_usage/analyze_output + +.. toctree:: + :maxdepth: 1 + :caption: Citation + + citation