From 0a8f031b59f8b61af650a5e508a452a45165f56e Mon Sep 17 00:00:00 2001 From: Benjamin Rodenberg Date: Mon, 10 Jul 2023 10:08:02 +0200 Subject: [PATCH] Update `CITATION.cff` to use `preferred-citation` (#157) * Update citation cff * Update ReleaseGuide.md * Refer to preCICE Literature guide --- CITATION.cff | 104 ++++++++++++++++++++++++++----------------- docs/ReleaseGuide.md | 9 ++-- 2 files changed, 68 insertions(+), 45 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 34b3f499..ef7b5316 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,45 +1,65 @@ -# YAML 1.2 ---- -abstract: "The new software FEniCS-preCICE is a middle software layer, sitting in between the existing finite-element library FEniCS and the coupling library preCICE. The middle layer simplifies coupling (existing) FEniCS application codes to other simulation software via preCICE. To this end, FEniCS-preCICE converts between FEniCS and preCICE mesh and data structures, provides easy-to-use coupling conditions, and manages data checkpointing for implicit coupling. The new software is a library itself and follows a FEniCS-native style. Only a few lines of additional code are necessary to prepare a FEniCS application code for coupling. We illustrate the functionality of FEniCS-preCICE by two examples: a FEniCS heat conduction code coupled to OpenFOAM and a FEniCS linear elasticity code coupled to SU2. The results of both scenarios are compared with other simulation software showing good agreement." -authors: - - - affiliation: "Technical University of Munich" +# This CITATION.cff file was generated with cffinit. +# Visit https://bit.ly/cffinit to generate yours today! + +cff-version: 1.2.0 +title: FEniCS-preCICE +message: >- + If you use this software, please cite it using the metadata from this file. When using or referring to preCICE in + academic publications, please follow the [citation guidelines](https://precice.org/fundamentals-literature-guide.html). +type: software +authors: + - given-names: Benjamin family-names: Rodenberg - given-names: Benjamin - orcid: "https://orcid.org/0000-0002-3116-0133" - - - affiliation: "University Stuttgart" + orcid: 'https://orcid.org/0000-0002-3116-0133' + affiliation: Technical University of Munich + - given-names: Ishaan family-names: Desai - given-names: Ishaan - orcid: "https://orcid.org/0000-0002-2552-7509" - - - family-names: Hertrich + orcid: 'https://orcid.org/0000-0002-2552-7509' + affiliation: University Stuttgart + - family-names: Hertrich given-names: Richard - orcid: "https://orcid.org/0000-0003-1722-2841" - - - affiliation: "University of Stuttgart" - family-names: Jaust - given-names: Alexander - orcid: "https://orcid.org/0000-0002-6082-105X" - - - affiliation: "University of Stuttgart" - family-names: Uekermann - given-names: Benjamin - orcid: "https://orcid.org/0000-0002-1314-9969" -cff-version: "1.1.0" -date-released: 2021-01-10 -keywords: - - FEniCS - - "Fluid-Structure Interaction" - - "Conjugate Heat Transfer" - - Multiphysics - - "Coupled Problems" - - "Finite Element Method" - - preCICE -license: "LGPL-3.0" -message: "If you use this software, please cite it using these metadata." -repository-code: "https://github.com/precice/fenics-adapter" -title: "FEniCS-preCICE: Coupling FEniCS to other Simulation Software" -version: 1.2.0 -doi: 10.1016/j.softx.2021.100807 -... + orcid: 'https://orcid.org/0000-0003-1722-2841' + - affiliation: University of Stuttgart + given-names: Jaust + family-names: Alexander + orcid: 'https://orcid.org/0000-0002-6082-105X' + - affiliation: University of Stuttgart + given-names: Uekermann + family-names: Benjamin + orcid: 'https://orcid.org/0000-0002-1314-9969' +repository-code: 'https://github.com/precice/fenics-adapter' +abstract: >- + preCICE-adapter for the open source computing platform + FEniCS. +license: LGPL-3.0 +commit: ' 9aa3e22' +version: 1.4.0 +date-released: '2022-09-22' +preferred-citation: + title: "FEniCS-preCICE: Coupling FEniCS to other Simulation Software" + type: "article" + authors: + - affiliation: "Technical University of Munich" + family-names: Rodenberg + given-names: Benjamin + orcid: "https://orcid.org/0000-0002-3116-0133" + - affiliation: "University Stuttgart" + family-names: Desai + given-names: Ishaan + orcid: "https://orcid.org/0000-0002-2552-7509" + - family-names: Hertrich + given-names: Richard + orcid: "https://orcid.org/0000-0003-1722-2841" + - affiliation: "University of Stuttgart" + family-names: Jaust + given-names: Alexander + orcid: "https://orcid.org/0000-0002-6082-105X" + - affiliation: "University of Stuttgart" + family-names: Uekermann + given-names: Benjamin + orcid: "https://orcid.org/0000-0002-1314-9969" + doi: 10.1016/j.softx.2021.100807 + journal: "SoftwareX" + volume: 16 + pages: 100807 + year: 2021 diff --git a/docs/ReleaseGuide.md b/docs/ReleaseGuide.md index c62583a5..1a6093c4 100644 --- a/docs/ReleaseGuide.md +++ b/docs/ReleaseGuide.md @@ -2,14 +2,17 @@ Before starting this process make sure to check that all relevant changes are included in the `CHANGELOG.md`. The developer who is releasing a new version of FEniCS-preCICE adapter is expected to follow this workflow: -1. If it does not already exist, create a release branch with the version number of the planned release. Use develop as base for the branch. `git checkout develop`; `git checkout -b fenics-adapter-vX.X.X`. Perform the following steps only on the release branch, if not indicated differently. +1. If it does not already exist, create a release branch with the version number of the planned release. Use develop as base for the branch. `git checkout develop`; `git checkout -b fenics-adapter-vX.X.X`. Perform the following steps only on the release branch, if not indicated differently. 2. [Open a Pull Request from the branch `fenics-adapter-vX.X.X` to `master`](https://github.com/precice/fenics-adapter/compare) named after the version (i.e. `Release v1.0.0`) and briefly describe the new features of the release in the PR description. 3. Bump the version in the following places: - a) Before merging the PR, make sure to bump the version in `CHANGELOG.md` on `fenics-adapter-vX.X.X` - b) There is no need to bump the version anywhere else, since we use the [python-versioneer](https://github.com/python-versioneer/python-versioneer/) for maintaining the version everywhere else. + a) Before merging the PR, make sure to bump the version in `CHANGELOG.md` on `fenics-adapter-vX.X.X`. + + b) Update the version in `CITATION.cff` and update the release date. + + c) There is no need to bump the version anywhere else, since we use the [python-versioneer](https://github.com/python-versioneer/python-versioneer/) for maintaining the version everywhere else. 4. [Draft a New Release](https://github.com/precice/fenics-adapter/releases/new) in the `Releases` section of the repository page in a web browser. The release tag needs to be the exact version number (i.e.`v1.0.0` or `v1.0.0rc1`, compare to [existing tags](https://github.com/precice/fenics-adapter/tags)). Use `@target:master`. Release title is also the version number (i.e. `v1.0.0` or `v1.0.0rc1`, compare to [existing releases](https://github.com/precice/fenics-adapter/tags)). *Note:* If it is a pre-release then the option *This is a pre-release* needs to be selected at the bottom of the page. Use `@target:fenics-adapter-vX.X.X` for a pre-release, since we will never merge a pre-release into master.