diff --git a/README.md b/README.md index 929e997a9..4314b3a41 100644 --- a/README.md +++ b/README.md @@ -14,19 +14,39 @@ Simulations of physical systems are often slow and need lots of compute, which m You can find the project documentation [here](https://alan-turing-institute.github.io/autoemulate/), including [installation](https://alan-turing-institute.github.io/autoemulate/installation.html). -## The AutoEmulate project +## Citation +Please cite this paper if you use the package in your work: -- The AutoEmulate project is run out of the [Alan Turing Institute](https://www.turing.ac.uk/). -- Visit [autoemulate.com](https://www.autoemulate.com/) to learn more. -- Feel free to reach out to us at [aiphys@turing.ac.uk](mailto:aiphys@turing.ac.uk) for queries about AutoEmulate or ideas for collaboration. -- We have also published a paper in [The Journal of Open Source Software](https://joss.theoj.org/papers/10.21105/joss.07626). +```bibtex +@article{Jersakova2026, + doi = {10.21105/joss.10087}, + url = {https://doi.org/10.21105/joss.10087}, + year = {2026}, + publisher = {The Open Journal}, + volume = {11}, + number = {124}, + pages = {10087}, + author = {Jersakova, Radka and Greenbury, Sam F. and Chalstrey, Ed and Brown, Edwin and Famili, Marjan and Sprague, Chris and Conti, Paolo and Smith, Camila Rangel and Stoffel, Martin A. and Li, Bryan M. and Westerling, Kalle and Arana, Sophie and Balmus, Max and Daub, Eric and Niederer, Steve and Duncan, Andrew B. and McEwen, Jason D.}, + title = {AutoEmulate: A PyTorch tool for end-to-end emulation workflows}, + journal = {Journal of Open Source Software} +} +``` +If you're using AutoEmulate version < 1.0, please cite our previous paper: - Please cite this paper if you use the package in your work: - - ```bibtex - @article{Stoffel2025, doi = {10.21105/joss.07626}, url = {https://doi.org/10.21105/joss.07626}, year = {2025}, publisher = {The Open Journal}, volume = {10}, number = {107}, pages = {7626}, author = {Martin A. Stoffel and Bryan M. Li and Kalle Westerling and Sophie Arana and Max Balmus and Eric Daub and Steve Niederer}, title = {AutoEmulate: A Python package for semi-automated emulation}, journal = {Journal of Open Source Software} } - ``` +```bibtex +@article{Stoffel2025, + doi = {10.21105/joss.07626}, + url = {https://doi.org/10.21105/joss.07626}, + year = {2025}, publisher = {The Open Journal}, + volume = {10}, + number = {107}, + pages = {7626}, + author = {Martin A. Stoffel and Bryan M. Li and Kalle Westerling and Sophie Arana and Max Balmus and Eric Daub and Steve Niederer}, + title = {AutoEmulate: A Python package for semi-automated emulation}, + journal = {Journal of Open Source Software} +} +``` ## Contributors