Merge branch 'master' into precice-v3

precice · Apr 28, 2023 · 792208b · 792208b
2 parents 862ed69 + f743bcf
commit 792208b
Show file tree

Hide file tree

Showing 12 changed files with 67 additions and 8 deletions.
diff --git a/_data/sidebars/docs_sidebar.yml b/_data/sidebars/docs_sidebar.yml
@@ -39,6 +39,10 @@ entries:
     - title: Roadmap
       url: /fundamentals-roadmap.html
       output: web, pdf
+
+    - title: Previous versions
+      url: /fundamentals-previous-versions.html
+      output: web, pdf
 
   - title: Installation
     output: web, pdf

diff --git a/images/events/precice2021-group.png b/images/events/precice2021-group.png
diff --git a/images/events/precice2022-group.png b/images/events/precice2022-group.png
diff --git a/images/events/precice2023-group.jpg b/images/events/precice2023-group.jpg
diff --git a/imported/tutorials b/imported/tutorials
diff --git a/pages/community/precice-workshop-2021.md b/pages/community/precice-workshop-2021.md
@@ -9,7 +9,9 @@ redirect_from: /preCICE2021/
 
 <img class="img-responsive center-block" src="images/events/precice2021.svg" alt="preCICE Workshop banner" style="max-width: 500px; margin:auto;">
 
-The 2nd preCICE Workshop will be held virtually through the [University of Stuttgart](https://www.uni-stuttgart.de/en/), from February 22-25, 2021. The workshop is a coming together of the preCICE community to share ideas, experiences and knowledge about using preCICE, and to learn from others in the process. [Registration](https://precice.org/precice-workshop-2021.html#registration) for the workshop is still open.
+<img class="img-responsive center-block" src="images/events/precice2021-group.png" alt="Group picture" style="width: 100%; margin:auto;">
+
+The 2nd preCICE Workshop was held virtually through the [University of Stuttgart](https://www.uni-stuttgart.de/en/), between February 22-25, 2021. The workshop is a coming together of the preCICE community to share ideas, experiences and knowledge about using preCICE, and to learn from others in the process. [Registration](https://precice.org/precice-workshop-2021.html#registration) for the workshop is closed.
 
 If you have any questions regarding the workshop, please contact us at precice2021@ipvs.uni-stuttgart.de.
 

diff --git a/pages/community/precice-workshop-2022.md b/pages/community/precice-workshop-2022.md
@@ -9,11 +9,11 @@ redirect_from: /preCICE2022/
 
 <img class="img-responsive center-block" src="images/events/precice2022.svg" alt="preCICE Workshop banner" style="max-width: 500px; margin:auto;">
 
-The 3rd preCICE Workshop will be held virtually through [SimTech](https://www.simtech.uni-stuttgart.de/) and the [University of Stuttgart](https://www.uni-stuttgart.de/en/), on February 21-24, 2022. The workshop is a coming together of the preCICE community to share ideas, experiences and knowledge about using preCICE, and to learn from others in the process.
+<img class="img-responsive center-block" src="images/events/precice2022-group.png" alt="Group picture" style="width: 100%; margin:auto;">
 
-[Registration](https://precice.org/precice-workshop-2022.html#registration) is now open. We look forward to welcoming back previous participants, and introducing more members to the preCICE community.
+The 3rd preCICE Workshop was held virtually through [SimTech](https://www.simtech.uni-stuttgart.de/) and the [University of Stuttgart](https://www.uni-stuttgart.de/en/), on February 21-24, 2022. The workshop is a coming together of the preCICE community to share ideas, experiences and knowledge about using preCICE, and to learn from others in the process.
 
-Due to the uncertain times we are experiencing with the ongoing COVID-19 pandemic and the great success of the virtual workshop in February 2021, we are planning to host the workshop virtually again.
+[Registration](https://precice.org/precice-workshop-2022.html#registration) is closed.
 
 If you have any questions regarding the workshop, please contact us at [`precice2022@ipvs.uni-stuttgart.de`](mailto:precice2022@ipvs.uni-stuttgart.de).
 

diff --git a/pages/community/precice-workshop-2023.md b/pages/community/precice-workshop-2023.md
@@ -13,6 +13,8 @@ redirect_from: /preCICE2023/
 This workshop is now over. See you next in [SIAM CSE23](https://meetings.siam.org/program.cfm?CONFCODE=CSE23) with several talks, a poster, and two minitutorial sessions, as well as in [ECCOMAS COUPLED23](eccomas-coupled-2023.html) with a minisymposium.
 {% endnote %}
 
+<img class="img-responsive center-block" src="images/events/precice2023-group.jpg" alt="Group picture" style="width: 100%; margin:auto;">
+
 The 4th preCICE Workshop was held in-presence at the campus Garching of the [Technical University of Munich](https://www.tum.de/) ([Leibniz Supercomputing Center](https://www.lrz.de/)), on February 13-16, 2023. The workshop is a coming together of the preCICE community to share ideas, experiences and knowledge about using preCICE, and to learn from others in the process.
 
 Expect user and developer talks, hands-on training sessions, discussions with the developers on your applications and use cases, feedback rounds, and plenty of opportunities to network with the rest of our vibrant community.

diff --git a/pages/docs/couple-your-code/couple-your-code-porting-v2-3.md b/pages/docs/couple-your-code/couple-your-code-porting-v2-3.md
@@ -36,15 +36,15 @@ Please add breaking changes here when merged to the `develop` branch.
 
 The previously optional argument `relativeReadTime` is now mandatory for read data calls. This requires you to update all read data calls. See [time interpolation](couple-your-code-waveform) for more details on this argument. If you don't want to use subcycling or time interpolation, you can simply get the required `relativeReadTime` by calling `double preciceDt = getMaxTimeStepSize()` call. Change:
 
-```diff cpp
+```diff
 - couplingInterface.readBlockVectorData(meshName, dataReadName, numberOfVertices, vertexIDs.data(), readData.data());
 + preciceDt = couplingInterface.getMaxTimeStepSize();
 + couplingInterface.readBlockVectorData(meshName, dataReadName, numberOfVertices, vertexIDs.data(), preciceDt, readData.data())
 ```
 
 If you use subcycling, please do the following:
 
-```diff cpp
+```diff
 - couplingInterface.readBlockVectorData(meshName, dataReadName, numberOfVertices, vertexIDs.data(), readData.data());
 + preciceDt = couplingInterface.getMaxTimeStepSize();
   double dt = min(preciceDt, solverDt);
@@ -55,7 +55,7 @@ If you use subcycling, please do the following:
 
 The API function `initializeData()` has been removed in [#1350](https://github.com/precice/precice/pull/1350). `initialize()` now takes care of all the initialization – including data initialization. This means, you have to call `initialize()`, where you previously called `initializeData()`. Be aware that this means that you have to write initial data before calling `initialize()`. Change:
 
-```diff cpp
+```diff
 - double dt = 0;
 - dt        = couplingInterface.initialize();
   std::vector<double> writeData(dimensions, writeValue);

diff --git a/pages/docs/couple-your-code/couple-your-code-time-step-sizes.md b/pages/docs/couple-your-code/couple-your-code-time-step-sizes.md
@@ -3,6 +3,8 @@ title: Step 5 – Non-matching time step sizes
 permalink: couple-your-code-time-step-sizes.html
 keywords: api, adapter, advance, timestepping, subcycling, adaptivity
 summary: "In this step, you learn how preCICE handles non-matching time step sizes and a few more things about simulation time."
+redirect_from:
+  - couple-your-code-timestep-sizes.html
 ---
 
 In previous steps, you have already seen that there are quite some things going on with time step sizes. Let us now have a look at what is actually happening.

diff --git a/pages/docs/fundamentals/fundamentals-previous-versions.md b/pages/docs/fundamentals/fundamentals-previous-versions.md
@@ -0,0 +1,15 @@
+---
+title: Previous versions
+permalink: fundamentals-previous-versions.html
+keywords: pdf, export, v1, v2
+summary: "Archives of this documentation"
+---
+
+In regular intervals, we archive PDF exports of this documentation. Refer to those when you are looking for information regarding previous versions:
+
+- For preCICE v2.x: [libprecice2_2.2.5_docs_v202211.0.0.pdf](https://github.com/precice/precice.github.io/releases/download/v202211.0.0/libprecice2_2.2.5_docs_v202211.0.0.pdf)
+- Before preCICE v2.x, the documentation was hosted in a [GitHub Wiki](https://github.com/precice/precice/wiki/Home/f6bfac33aa878ab3e89e60720894e4fe0a547ab4). For each page you want to visit, look at the previous revisions.
+
+We only support the latest version of preCICE, but upgrading is easy: See our [porting guides](./couple-your-code-porting-overview.html).
+
+The PDF exports of the documentation are part of the [preCICE Distribution](./installation-distribution.html). Alternatively, you can build [previous states of this website](https://github.com/precice/precice.github.io).
diff --git a/pages/index.html b/pages/index.html
@@ -318,6 +318,40 @@ <h2 class="section-header">Academic at heart, 100% free software</h2>
   </div> <!-- section -->
 </div> <!-- container -->
 
+<!-- Community -->
+
+<div class="background-light">
+  <div class="container">
+    <div  class="section">
+
+      <div class="row">
+        <div class="col-lg-12">
+          <h2 class="section-header">Join the community!</h2>
+        </div>
+      </div>
+
+      <div class="row equal">
+        <div class="col-md-8 col-flex">
+          <p>We develop everything in the open, with continuous feedback by a vivid community. Be part of it:</p>
+          <ul>
+            <li><strong>Ask for help and help others</strong> in the <a href="https://precice.discourse.group/">preCICE forum</a> and register to receive news.</li>
+            <li>Directly <strong>edit the documentation</strong>. We review and help - nothing can go wrong.</li>
+            <li>Report issues on <a href="https://github.com/precice/">GitHub</a> and help us solve them for everyone.</li>
+            <li><a href="community-contribute-to-precice.html">Contribute</a> code and simulation examples - we help you with guidelines, tools, and reviews.</li>
+            <li><strong>Meet the community</strong> in one of the <a href="community.html">preCICE workshops and conference sessions</a>.</li>
+          </ul>
+        </div>
+        <div class="col-md-4 col-flex">
+          <a href="community.html">
+            <img class="img-responsive center-block img-rounded" src="images/events/precice2023-group.jpg" alt="preCICE Workshop group picture">
+          </a>
+        </div>
+      </div>
+      </div><!-- main -->
+    </div> <!-- section -->
+  </div> <!-- container -->
+</div> <!-- light background -->
+
 <!-- Precice support program  -->
 
 <div class="background-dark">