Skip to content

Commit

Permalink
Add citation information
Browse files Browse the repository at this point in the history
  • Loading branch information
AngelFP committed Aug 18, 2023
1 parent 61af0d0 commit 9f912f5
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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},
Expand Down
38 changes: 38 additions & 0 deletions doc/source/user_guide/citation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Citing optimas
==============

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>`_:

.. 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}
}
8 changes: 7 additions & 1 deletion doc/source/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,10 @@ User guide

basic_usage/basic_setup
basic_usage/running_with_simulations
basic_usage/analyze_output
basic_usage/analyze_output

.. toctree::
:maxdepth: 1
:caption: Citation

citation

0 comments on commit 9f912f5

Please sign in to comment.