Skip to content
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 3 additions & 1 deletion content/404.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@ title: "Page Not Found"
search: exclude
hide_sidebar: true
permalink: /404.html
aliases:
- /404.html
editme: false
---

<br>

![404 - page not found](images/404.png)
![404 - page not found](/images/404.png)

<br>

Expand Down
13 changes: 13 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: preCICE - The Coupling Library
keywords:
toc: false
hide_sidebar: true
topnav: topnav
cascade:
layout: page
comments: false
search: true
sidebar: home_sidebar
topnav: topnav
---
59 changes: 59 additions & 0 deletions content/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: About the preCICE project
permalink: about.html
aliases:
- /about.html
- /timeline/
keywords: about, project leaders, timeline, impressum, legal
summary:
hide_sidebar: true
toc: false
editme: false
redirect_from:
- /timeline/
---

## Development

preCICE is developed in the groups of [Benjamin Uekermann (Usability and Sustainability of Simulation Software)](https://www.ipvs.uni-stuttgart.de/departments/us3/) and [Miriam Schulte (Simulation of Large Systems)](https://www.ipvs.uni-stuttgart.de/departments/sgs/) at the University of Stuttgart and in the group of [Hans-Joachim Bungartz (Scientific Computing in Computer Science)](https://www.cs.cit.tum.de/en/sccs/home/) at the Technical University of Munich. [Support contracts](community-support-precice.html) are offered through [TTI GmbH](https://www.tti-stuttgart.de/).

<br>
<img class="img-fluid mx-auto d-block" src="/images/developer/precice-devs.png" alt="preCICE contributors" style="max-width: 800px; width: 100%;">
<br>

For the full list of contributors to preCICE please see our [community page](community-contributors).

The conceptual ideas of preCICE are not completely new. preCICE is an advancement of FSI*ce, developed by Markus Brenk.

## Planning and development of precice.org

The website in its current form was planned and implemented by CH Lorenz Research and Innovation Consulting together with the preCICE team. For more information contact [Christopher Lorenz](https://christopherlorenz.com) at christopher[dot]lorenz[at]chlorenz[dot]ug.

## Funding

{{< funding >}}

## Prince XML

We use a non-commercial license of [Prince XML](http://www.princexml.com/) to generate the PDF version of the documentation. For more information see our [meta documentation page](docs-meta-publish-to-pdf.html).

## Website analytics

We use the open-source and privacy-friendly analytics service [Plausible](https://plausible.io/). Everyone can see the [analytics for this website](https://plausible.io/precice.org).

## Impressum

This website is maintained by

Benjamin Uekermann -
Universität Stuttgart -
Universitätsstraße 38 -
70569 Stuttgart

## Privacy

You can find the preCICE [privacy policy here](privacy.html).

![preCICE doughnuts](/images/doughnuts.jpg)

preCICE is tasty because it is made with love by its contributors.
Empty file removed content/about/_index.md
Empty file.
113 changes: 0 additions & 113 deletions content/about/overview.md

This file was deleted.

10 changes: 10 additions & 0 deletions content/community/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Community
cascade:
layout: page
comments: false
search: true
sidebar: community_sidebar
topnav: topnav
toc: true
---
5 changes: 4 additions & 1 deletion content/community/channels.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: Community channels
permalink: community-channels.html
aliases:
- /community-channels.html
- /resources/
keywords: contact, follow, social, stay in touch, news, videos, YouTube, Gitter, newsletter, newsfeed, mailing list, mastodon, bluesky
summary:
toc: false
Expand All @@ -15,7 +18,7 @@ We have all been there: you start using a new tool, only to find out that you do

You can find us on our [preCICE forum on Discourse](https://precice.discourse.group/), which is great for structured discussions that help everyone. We try our best to help everyone, but this approach does not scale. We would be very happy if you also try to help others - only together way we can build a helping and welcoming online community!

For quick orientation questions, feel free to drop us a short message on the [preCICE Matrix chatroom]({{ site.matrix_url }}).
For quick orientation questions, feel free to drop us a short message on the [preCICE Matrix chatroom](https://matrix.to/#/#precice_lobby:gitter.im?web-instance%5Belement.io%5D=app.gitter.im).

## I want to stay up-to-date

Expand Down
40 changes: 24 additions & 16 deletions content/community/contribute/contribute-to-precice.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Contribute to preCICE
permalink: community-contribute-to-precice.html
aliases:
- /community-contribute-to-precice.html
keywords: contribute, develop
summary:
toc: true
Expand Down Expand Up @@ -72,9 +74,9 @@ or to demonstrate a new feature. We welcome contributions to our [tutorials repo
and we will discuss it with you over a few [review](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request) iterations.
If you roughly follow the guidelines in this section, your contribution could be merged very quickly. Since we aim to maintain and update all tutorials, it is important for us that every tutorial merged follows the same structure and conventions.

{% tip %}
{{< tip >}}
Get in touch with us early and we will be very happy to help you with every step! Open a first draft Pull Request on GitHub and we can together bring it into a fitting shape.
{% endtip %}
{{< /tip >}}

First time working with Git? Watch a [lecture on Git](https://missing.csail.mit.edu/2020/version-control/).

Expand Down Expand Up @@ -147,9 +149,9 @@ In the `README.md` file, following the general structure of the existing tutoria
- an example picture or video of the results.
- Don't forget to adapt the `permalink:` field in the beginning of the file.

{% note %}
If you add a complete new tutorial case, the case also needs to be added to the [tutorials sidebar](https://github.com/precice/precice.github.io/blob/master/_data/sidebars/tutorial_sidebar.yml) on the [tutorials website section](tutorials.html). Please open a pull request to the [website repository](https://github.com/precice/precice.github.io).
{% endnote %}
{{< note >}}
If you add a complete new tutorial case, also add its Hugo module mounts to `config/_default/module.toml` and its permalink to the [tutorials sidebar](https://github.com/precice/precice.github.io/blob/master/data/sidebars/tutorials_sidebar.yml) in a pull request to the [website repository](https://github.com/precice/precice.github.io).
{{< /note >}}

### The metadata file

Expand Down Expand Up @@ -191,7 +193,7 @@ After testing and merging, we will generate the reference results of the new tes
- Mesh names start with the participant/domain name, e.g. `Fluid-Mesh`.
- Mesh names of participants with multiple interfaces contain the interface in the mesh name, e.g. `Fluid-Upstream-Mesh`. For meshes on which it is important to distinguish between face centers and face nodes, the modifier comes at the end, e.g. `Fluid-Upstream-Mesh-Centers`.
- Watchpoint names should be describing the point, not be a generic name.
- Images need to be named as `tutorials-<tutorial>-<image>.png` to be correctly displayed on the website. You can then refer to them as `![title](images/tutorials-<tutorial>-<image>.png)`. Subdirectories are not allowed.
- Images need to be named as `tutorials-<tutorial>-<image>.png` to be correctly displayed on the website. You can then refer to them as `![title](/images/tutorials-<tutorial>-<image>.png)`. Subdirectories are not allowed.
Comment thread
MuhammadAashirAslam marked this conversation as resolved.
Outdated

### Open a pull request

Expand All @@ -215,14 +217,20 @@ We automate many checks with [GitHub actions](https://github.com/features/action

### Adding a new tutorial to the website

The content of the tutorials is sourced from the develop branch of the tutorials repository, which is specified in the `.gitmodules` file of the website repository. Hence, in general, anything merged to develop in the tutorials appears on the website. Consider putting some `note` [alert box](docs-meta-cheatsheet.html#alerts) on top of your new tutorial page to describe any unreleased requirements.
Tutorial content is imported from the tutorials repository with Hugo Modules.
The **Update Hugo modules** workflow records the selected tutorial revision in
Comment thread
MuhammadAashirAslam marked this conversation as resolved.
Outdated
`go.mod` and `go.sum`. Consider putting a `note`
[alert box](docs-meta-cheatsheet.html#alerts) on top of your new tutorial page
to describe any unreleased requirements.

*New* tutorials will not directly appear on the website, but they need some additional steps. After merging to the tutorials develop, open a pull request with the following changes in the [website repository](https://github.com/precice/precice.github.io) ([example](https://github.com/precice/precice.github.io/pull/275)):
New tutorials will not directly appear on the website. After merging a new
tutorial, open a pull request with these changes in the
[website repository](https://github.com/precice/precice.github.io):

1. Trigger the [update submodules workflow](https://github.com/precice/precice.github.io/actions/workflows/update-submodules.yml) and, after it completes, create a new branch and pull request (this may also happen automatically, or someone from the preCICE team may have to do it for you).
2. Edit the [`_config.yml` file](https://github.com/precice/precice.github.io/blob/master/_config.yml) to append the directory name of your tutorial under `subprojects:`.
3. Edit the [tutorials sidebar](https://github.com/precice/precice.github.io/blob/master/_data/sidebars/tutorial_sidebar.yml) to add your tutorial permalink (defined in the heading of the `README.md` you created) to a fitting place, next to a similar tutorial.
4. Edit the [tutorials landing page](https://github.com/precice/precice.github.io/blob/master/content/tutorials/overview.md) to add your tutorial to the overview.
1. Add the tutorial's Hugo module mounts to `config/_default/module.toml`.
2. Add its permalink to a fitting place in the
[tutorials sidebar](https://github.com/precice/precice.github.io/blob/master/data/sidebars/tutorials_sidebar.yml), next to a similar tutorial.
3. Edit the [tutorials landing page](https://github.com/precice/precice.github.io/blob/master/content/tutorials/overview.md) to add the tutorial to the overview.

After your PR gets reviewed, approved, and merged, the website will be built automatically, and your tutorial will appear online in a couple of minutes.

Expand All @@ -236,13 +244,13 @@ You can pick up issues that you would like to work on from any repository you li

Look for [contributing guidelines](https://github.com/precice/precice/blob/develop/docs/CONTRIBUTING.md) in each repository. The [developer documentation](dev-docs-overview.html) will also be useful.

{% tip %}
{{< tip >}}
Read on our [Roadmap](fundamentals-roadmap.html) what is already in our to-do list before starting to write large parts of code.
{% endtip %}
{{< /tip >}}

{% tip %}
{{< tip >}}
There are [guidelines for adapters](community-guidelines-adapters.html) and [guidelines for application cases](community-guidelines-application-cases.html).
{% endtip %}
{{< /tip >}}

## Helping other users

Expand Down
15 changes: 9 additions & 6 deletions content/community/contribute/open-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ keywords: contribute, GSoC, google summer of code, student
summary: Open opportunities for contributing to preCICE
toc: true
permalink: community-contribute-open-projects.html
aliases:
- /community-contribute-open-projects.html
- /gsoc/
redirect_from:
- /gsoc/
---
Expand Down Expand Up @@ -32,9 +35,9 @@ If you want to contribute with a student project (typically a thesis), see the [
This page highlights a few specific projects that are not directly suitable for a thesis ([thesis-suitable issues in the core library](https://github.com/precice/precice/issues?q=is%3Aissue%20state%3Aopen%20label%3Athesis)), but are also a bit more than a [good first issue](https://github.com/precice/precice/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22).
Some of these projects we advertise publicly, in programs such as the Google Summer of Code.

{% tip %}
{{< tip >}}
Are you looking for or offering a thesis / PhD / other related job? Have a look also at [our forum](https://precice.discourse.group/c/jobs/13).
{% endtip %}
{{< /tip >}}

## Google Summer of Code (GSoC)

Expand All @@ -54,16 +57,16 @@ Additionally, show us what you have tried already (see "entry test" in each proj

We will contact you via replies and/or private messages in the forum, to find out together if these topics are a good fit. You can alternatively ask quick questions in the [Matrix chat](https://matrix.to/#/#precice_lobby:gitter.im?web-instance[element.io]=app.gitter.im). Don't miss the [guidelines](#general-guidelines) at the bottom of this page.

{% important %}
{{< important >}}
We are a small project, and we are experiencing a spike of activity, which is very difficult to review next to the usual work.
Please do not ask whether you can work on an issue - not without details. If you find something interesting to you that you feel it is clear enough for you to contribute, go ahead and submit a PR.
We value quality higher than quantity. If you find something interesting, take your time and focus on it.
We expect to work with the accepted GSoC participants in the summer. Our capacity to review external contributions before that is very limited.
{% endimportant %}
{{< /important >}}

{% important %}
{{< important >}}
We have already received too many pull requests in the period before proposals open. For this reason, we have now restricted interactions with the preCICE repositories to collaborators. If you have not reached out so far, chances for selection are very small.
{% endimportant %}
{{< /important >}}

### Submitting proposals

Expand Down
Loading
Loading