From a3ef4ae2c912a36d114eb9ac470c01173de006ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakob=20H=C3=A6rvig?= Date: Fri, 7 Jun 2024 08:40:40 +0200 Subject: [PATCH] Add Citing OpenTerrace page to navigation menu --- docs/citing.md | 18 ++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 19 insertions(+) create mode 100644 docs/citing.md diff --git a/docs/citing.md b/docs/citing.md new file mode 100644 index 0000000..452bb02 --- /dev/null +++ b/docs/citing.md @@ -0,0 +1,18 @@ +If you use this software in your work, please cite this [article](https://doi.org/10.21105/joss.06411): + +**Citation** + +``Hærvig, J. (2024). OpenTerrace: A fast, flexible and extendable Python framework for thermal energy storage packed bed simulations. Journal of Open Source Software, 9(98), 6411. https://doi.org/10.21105/joss.06411`` + +**BibTeX entry** + +``@article{Haervig_OpenTerrace_A_fast_2024, author = {Hærvig, Jakob}, +doi = {10.21105/joss.06411}, +journal = {Journal of Open Source Software}, +month = jun, +number = {98}, +pages = {6411}, +title = {{OpenTerrace: A fast, flexible and extendable Python framework for thermal energy storage packed bed simulations}}, +url = {https://github.com/OpenTerrace/openterrace-python}, +volume = {9}, +year = {2024}}`` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 84fbebb..dd01815 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -105,6 +105,7 @@ nav: - Verification studies: user-guide/verification-and-validation/verification.md - Validation studies: user-guide/verification-and-validation/validation.md - source_code.md + - Citing OpenTerrace: citing.md - Contributing and contact: - contributing.md - contact.md \ No newline at end of file