Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@MakisH
Copy link
Member

@MakisH MakisH commented Aug 14, 2022

This PR closes #177:

  • Replaces the preCICE v1 paper with the v2 paper on the landing page.
    • Still mentions the citations to the v1 paper. On the one hand, these are currently more useful. On the other hand, Google Scholar does not seem to have listed our ORE paper yet (does it wait for citations, or does it get confused by the arXiv duplicate?). As a next step, I would add both buttons, when available (see Missing citations link/count for v2 paper #200).
    • Adds two thumbnails: one with a "new" stamp on it, one without (for later).
  • Adds a "When to cite what" section in the literature guide page.
    • Refers to key references with cards from our simplistic database, as previously done for the FEniCS adapter.
    • Asks to always cite the v2 paper, still maintains a link to the v1 paper.
    • Asks to cite adapter reference papers and gives the old adapters paper for the general concept and the OpenFOAM, CalculiX, SU2, and code_aster adapters. Mentions that for OpenFOAM, there is an article in review.
    • Adds a link to the preCICE distribution to the subsection "Reproducibility"
  • Adds a reference to the v2 paper in the mapping feature, as a comparison of mapping methods.
  • Reworks the introduction of the literature guide to refer to the Google Scholar citations list for the v1 paper.
  • Removes all the entries from the "Adapters" section of the literature guide, referring to the documentation pages of each adapter, the old overview paper, and the v2 reference paper. Also moves the link to Alex's thesis to the SU2 docs overview.
  • Removes the community/publications page (also from the sidebar) and adds redirects from publications.html and the old /publications/ to the literature guide.

I did not remove the entries from our internal database, since they are actually useful. One can render any publication as a card in any page. In fact, I added a new entry for our v2 paper and reworked the entry for the old adapters overview article.

One aspect I am not sure about is if the current DOI will automatically lead or hint to the latest revision of our paper, as a second one is expected. In any case, we can just find & replace once that is needed.

@uekerman please have a look if this looks as agreed (and if there are any typos) and merge. Some screenshots to help the review:


Landing page:

Screenshot from 2022-08-14 17-50-06


Literature guide:

Screenshot 2022-08-14 at 17-49-29 Literature guide preCICE - The Coupling Library

@MakisH MakisH added the content Content-only issues label Aug 14, 2022
@MakisH MakisH requested a review from uekerman August 14, 2022 16:13
@MakisH MakisH self-assigned this Aug 14, 2022
Copy link
Member

@uekerman uekerman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very good. Everything as agreed 👍

One aspect I am not sure about is if the current DOI will automatically lead or hint to the latest revision of our paper

I think so. If not, you get a very visible link "there is a newer version available" IIRC.

@MakisH MakisH merged commit 72d9c33 into master Aug 14, 2022
@MakisH MakisH deleted the citing-guide branch August 14, 2022 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content Content-only issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add "when to cite what" guide

2 participants