Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cr-xu authored Mar 4, 2024
1 parent 580345a commit 4a5271b
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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#/).
Expand All @@ -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
Expand Down Expand Up @@ -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).
Expand Down

0 comments on commit 4a5271b

Please sign in to comment.