From 4a5271bb129dfd19afa7f1e4ce9918fb8317ac72 Mon Sep 17 00:00:00 2001 From: Chenran Xu Date: Mon, 4 Mar 2024 22:10:01 +0900 Subject: [PATCH] Update README.md --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 58c0288..b845573 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![DOI](https://zenodo.org/badge/761710489.svg)](https://zenodo.org/doi/10.5281/zenodo.10777476) + # Tutorial on Applying Reinforcement Learning to the Particle Accelerator ARES You can view the tutorial notebook as [HTML slides here](https://RL4AA.github.io/rl-tutorial-ares-basic/slides.html#/). @@ -14,7 +16,7 @@ To check if you have it installed, open your terminal and type: git --version ``` -#### Git installation in MacOS +#### Git installation in macOS ``` bash brew update @@ -121,6 +123,28 @@ Alternatively, you can use supported Editor to run the jupyter notebooks, e.g. w --- +## Citing the tutorial + +This tutorial is registered [Zenodo](https://zenodo.org/doi/10.5281/zenodo.10777476). +Please use this DOI when citing this code: + +```bibtex +@software{chenran_xu_2024_10777477, + author = {Chenran Xu and + Andrea Santamaria Garcia and + Jan Kaiser}, + title = {{RL4AA/rl-tutorial-ares-basic: v1.0.0}}, + month = {03}, + year = {2024}, + publisher = {Zenodo}, + version = {v1.0.0}, + doi = {10.5281/zenodo.10777477}, + url = {https://doi.org/10.5281/zenodo.10777477} +} +``` + +--- + ## Acknowledgement This tutorial is developed by [Jan Kaiser](https://github.com/jank324), [Andrea Santamaria Garcia](https://github.com/ansantam), and [Chenran Xu](https://github.com/cr-xu).