diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..31303f6 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,23 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +authors: + - family-names: Xu + given-names: Chenran + affiliation: Karlsruhe Institute of Technology + orcid: "https://orcid.org/0000-0002-5034-2207" + - family-names: Santamaria Garcia + given-names: Andrea + affiliation: Karlsruhe Institute of Technology + orcid: "https://orcid.org/0000-0002-7498-7640" + - family-names: Kaiser + given-names: Jan + affiliation: Deutsches Elektronen-Synchrotron DESY + orcid: "https://orcid.org/0000-0003-3445-0678" + +title: "Tutorial on Applying Reinforcement Learning to the Particle Accelerator ARES" +date-released: 2024-03-25 +type: software +version: 1.0.1 +doi: 10.5281/zenodo.10777477 +license: GPL-3.0 +url: "https://github.com/machine-learning-tutorial/neural-networks" diff --git a/README.md b/README.md index b58f70f..9683763 100644 --- a/README.md +++ b/README.md @@ -131,19 +131,19 @@ 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: +This tutorial is uploaded to [Zenodo](https://zenodo.org/doi/10.5281/zenodo.10777476). +Please use the following 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}}, +@software{xu_2024_10777477, + author = {Xu, Chenran and + Santamaria Garcia, Andrea and + Kaiser, Jan}, + title = {Tutorial on Applying Reinforcement Learning to the Particle Accelerator {ARES}}, month = {03}, year = {2024}, publisher = {Zenodo}, - version = {v1.0.0}, + version = {v1.0.1}, doi = {10.5281/zenodo.10777477}, url = {https://doi.org/10.5281/zenodo.10777477} }