diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 00000000..603a13b8 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,50 @@ +cff-version: "1.2.0" +authors: +- family-names: Schneider + given-names: David + orcid: "https://orcid.org/0000-0002-3487-9688" +- family-names: Yurt + given-names: Muhammed Kürşat + orcid: "https://orcid.org/0000-0001-6497-3184" +- family-names: Simonis + given-names: Frédéric + orcid: "https://orcid.org/0000-0003-3390-157X" +- family-names: Uekermann + given-names: Benjamin + orcid: "https://orcid.org/0000-0002-1314-9969" +contact: +- family-names: Schneider + given-names: David + orcid: "https://orcid.org/0000-0002-3487-9688" +doi: 10.18419/darus-4562 +message: If you use this software, please cite our article in the + Journal of Open Source Software. +preferred-citation: + authors: + - family-names: Schneider + given-names: David + orcid: "https://orcid.org/0000-0002-3487-9688" + - family-names: Yurt + given-names: Muhammed Kürşat + orcid: "https://orcid.org/0000-0001-6497-3184" + - family-names: Simonis + given-names: Frédéric + orcid: "https://orcid.org/0000-0003-3390-157X" + - family-names: Uekermann + given-names: Benjamin + orcid: "https://orcid.org/0000-0002-1314-9969" + date-published: 2024-11-14 + doi: 10.21105/joss.07127 + issn: 2475-9066 + issue: 103 + journal: Journal of Open Source Software + publisher: + name: Open Journals + start: 7127 + title: "ASTE: An artificial solver testing environment for partitioned + coupling with preCICE" + type: article + url: "https://joss.theoj.org/papers/10.21105/joss.07127" + volume: 9 +title: "ASTE: An artificial solver testing environment for partitioned + coupling with preCICE" diff --git a/docs/README.md b/docs/README.md index 49e9c536..57fae79f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,6 +13,14 @@ ASTE is a collection of tools that can be used to reproduce and evaluate particu 2. Replay mode, where we replace a participant in a coupled setup with ASTE resulting in a uni-directional coupling. This is useful for debugging, for developing new adapters, but also for efficiency reasons (explicit instead of implicit coupling, no computationally demanding solver needs to be executed). +## Citing + +If you use this software, please cite our article in the Journal of Open Source Software: + +DOI: [10.21105/joss.07127](https://doi.org/10.21105/joss.07127) + +[![DOI](https://joss.theoj.org/papers/10.21105/joss.07127/status.svg)](https://doi.org/10.21105/joss.07127) + ## Installation The core module, which interfaces with preCICE, is called `precice-aste-run` and written in C++. In addition, ASTE offers several tools for pre- and post-processing purposes written in python.